net.guerlab.cloud.web.provider.BaseManageController Maven / Gradle / Ivy
/*
* Copyright 2018-2024 guerlab.net and other contributors.
*
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 3 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/lgpl-3.0.html
*
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.guerlab.cloud.web.provider;
import java.util.Collections;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import net.guerlab.cloud.commons.Constants;
import net.guerlab.cloud.commons.api.DeleteById;
import net.guerlab.cloud.commons.api.ManageApi;
import net.guerlab.cloud.commons.api.UpdateById;
import net.guerlab.cloud.commons.entity.IBaseEntity;
import net.guerlab.cloud.commons.valid.InsertValid;
import net.guerlab.cloud.commons.valid.UpdateValid;
import net.guerlab.cloud.log.annotation.Log;
import net.guerlab.cloud.searchparams.SearchParams;
/**
* 基础管理控制器实现.
*
* @param 实体类型
* @param 搜索参数类型
* @param api接口类型
* @param 返回对象类型
* @author guer
*/
@SuppressWarnings("unused")
@Slf4j
@Getter
public abstract class BaseManageController, V> extends BaseQueryController {
/**
* 根据api实例创建控制器.
*
* @param api api实例
*/
protected BaseManageController(A api) {
super(api);
}
@Log("method.insert")
@PostMapping
@Operation(summary = "新增实体", security = @SecurityRequirement(name = Constants.TOKEN))
public V insert(@Validated(InsertValid.class) @RequestBody E entity) {
beforeInsertCheck(entity);
entity = getApi().insert(entity);
V vo = convert(entity);
afterFind(Collections.singletonList(vo), null);
return vo;
}
/**
* 保存前置检查.
*
* @param entity 实体
*/
@SuppressWarnings("EmptyMethod")
protected void beforeInsertCheck(E entity) {
}
@Log("method.updateById")
@PostMapping(UpdateById.UPDATE_BY_ID_PATH)
@Operation(summary = "根据Id编辑数据", security = @SecurityRequirement(name = Constants.TOKEN))
public V updateById(@Validated(UpdateValid.class) @RequestBody E entity) {
Long id = entity.id();
if (id == null) {
throw nullPointException();
}
beforeUpdateCheck(entity);
getApi().updateById(entity);
V vo = selectById(id, null);
if (vo == null) {
throw nullPointException();
}
return vo;
}
/**
* 更新前置检查.
*
* @param entity 实体
*/
@SuppressWarnings("EmptyMethod")
protected void beforeUpdateCheck(E entity) {
}
@Log("method.deleteById")
@DeleteMapping(DeleteById.DELETE_BY_ID_PATH)
@Operation(summary = "根据Id删除数据", security = @SecurityRequirement(name = Constants.TOKEN))
public void deleteById(@Parameter(description = "ID", required = true) @PathVariable(DeleteById.DELETE_BY_ID_PARAM) Long id) {
E entity = getApi().selectById(id);
if (entity == null) {
throw nullPointException();
}
beforeDeleteCheck(entity);
getApi().deleteById(id);
}
/**
* 删除前置检查.
*
* @param entity 实体
*/
@SuppressWarnings("EmptyMethod")
protected void beforeDeleteCheck(E entity) {
}
@Log("method.delete")
@DeleteMapping
@Operation(summary = "根据搜索参数删除数据", security = @SecurityRequirement(name = Constants.TOKEN))
public void delete(@Parameter(description = "搜索参数", required = true) @RequestBody Q searchParams) {
beforeDelete(searchParams);
getApi().delete(searchParams);
}
/**
* 删除前置处理.
*
* @param searchParams 查询对象
*/
@SuppressWarnings("EmptyMethod")
protected void beforeDelete(Q searchParams) {
}
}