com.github.sparkzxl.database.base.controller

接口 CurdController<Entity,Id extends Serializable,SaveDTO,UpdateDTO,QueryDTO,ExcelEntity>

所有超级接口:

BaseController<Entity>

所有已知实现类:

SuperCacheController, SuperController

public interface CurdController<Entity,Id extends Serializable,SaveDTO,UpdateDTO,QueryDTO,ExcelEntity>
extends BaseController<Entity>

description: curd 接口自动生成类

作者:

zhouxinlei

字段概要

字段

限定符和类型	字段和说明
static org.slf4j.Logger	logger

方法概要

限定符和类型	方法和说明
default List<ExcelEntity>	convertExcels(List<Entity> entityList) 转换Excel表格
default boolean	delete(DeleteDTO<Id> deleteDTO) 删除方法
default void	exportData(QueryDTO queryDTO, javax.servlet.http.HttpServletResponse response) Excel导出数据
default Entity	get(Id id) 查询对象
default String	getDbField(String beanField, Class<?> clazz) 根据 bean字段 反射出 数据库字段
default String	getFileName() 获取文件名
default ImportDataListener<?>	getImportDataListener() Excel处理类
default boolean	handlerDelete(List<Id> ids) 自定义删除
default void	handlerEntity(Entity entity) 处理参数
default boolean	handlerExcelQueryList(QueryDTO queryDTO, List<Entity> entityList) 自定义查询Excel数据
default void	handlerQueryParams(PageParams<QueryDTO> params) 处理参数
default com.github.pagehelper.PageInfo<?>	handlerResult(com.github.pagehelper.PageInfo<Entity> pageInfo) 自定义处理返回结果
default boolean	handlerSave(SaveDTO model) 自定义新增
default boolean	handlerUpdate(UpdateDTO model) 自定义更新
default com.baomidou.mybatisplus.core.conditions.query.QueryWrapper<Entity>	handlerWrapper(Entity model, PageParams<QueryDTO> params) 条件构造
default Integer	importData(org.springframework.web.multipart.MultipartFile multipartFile) Excel导入数据
default Class<?>	importExcelClass() 导入Excel处理类
default com.github.pagehelper.PageInfo<?>	page(PageParams<QueryDTO> params) 分页查询
default com.github.pagehelper.PageInfo<?>	query(PageParams<QueryDTO> params) 执行查询 可以覆盖后重写查询逻辑
default List<Entity>	query(QueryDTO data) 批量查询
default boolean	save(SaveDTO saveDTO) 新增
default boolean	update(UpdateDTO updateDTO) 修改

从接口继承的方法 com.github.sparkzxl.database.base.controller.BaseController

getBaseService, getEntityClass

字段详细资料

logger

static final org.slf4j.Logger logger

方法详细资料

save

@PostMapping(value="/save")
default boolean save(@RequestBody @Validated
                                                 SaveDTO saveDTO)

新增

参数:

saveDTO - 保存参数

返回:

实体

handlerSave

default boolean handlerSave(SaveDTO model)

自定义新增

参数:

model - 保存DTO

返回:

返回true, 调用默认更新, 返回其他不调用默认更新

update

@PutMapping(value="/update")
default boolean update(@RequestBody @Validated
                                                    UpdateDTO updateDTO)

修改

参数:

updateDTO - 更新参数

返回:

boolean

handlerUpdate

default boolean handlerUpdate(UpdateDTO model)

自定义更新

参数:

model - 保存DTO

返回:

返回true, 调用默认更新, 返回其他不调用默认更新

delete

@DeleteMapping(value="/delete")
default boolean delete(@RequestBody
                                                       DeleteDTO<Id> deleteDTO)

删除方法

参数:

deleteDTO - ids

返回:

boolean

handlerDelete

default boolean handlerDelete(List<Id> ids)

自定义删除

参数:

ids - ids

返回:

返回true, 调用默认更新, 返回其他不调用默认更新

handlerResult

default com.github.pagehelper.PageInfo<?> handlerResult(com.github.pagehelper.PageInfo<Entity> pageInfo)

自定义处理返回结果

参数:

pageInfo - 数据返回list

返回:

List

getDbField

default String getDbField(String beanField,
                          Class<?> clazz)

根据 bean字段 反射出 数据库字段

参数:

beanField - 实体字段

clazz - 类

返回:

String

get

@GetMapping(value="/get")
default Entity get(@RequestParam(value="id")
                                             Id id)

查询对象

参数:

id - 主键

返回:

Entity

page

@PostMapping(value="/page")
default com.github.pagehelper.PageInfo<?> page(@RequestBody @Validated
                                                                           PageParams<QueryDTO> params)

分页查询

参数:

params - 分页参数

返回:

PageInfo

query

default com.github.pagehelper.PageInfo<?> query(PageParams<QueryDTO> params)

执行查询 可以覆盖后重写查询逻辑

参数:

params - 分页参数

返回:

分页结果

handlerEntity

default void handlerEntity(Entity entity)

处理参数

参数:

entity - 实体对象

handlerQueryParams

default void handlerQueryParams(PageParams<QueryDTO> params)

处理参数

参数:

params - 分页参数

handlerWrapper

default com.baomidou.mybatisplus.core.conditions.query.QueryWrapper<Entity> handlerWrapper(Entity model,
                                                                                           PageParams<QueryDTO> params)

条件构造

参数:

model - 对象

params - 分页参数

返回:

QueryWrap

query

@PostMapping(value="/list")
default List<Entity> query(@RequestBody
                                                       QueryDTO data)

批量查询

参数:

data - list查询

返回:

查询结果

importData

@PostMapping(value="/import")
default Integer importData(@RequestParam(value="file")
                                                         org.springframework.web.multipart.MultipartFile multipartFile)

Excel导入数据

参数:

multipartFile - 文件

返回:

导入记录数

getImportDataListener

default ImportDataListener<?> getImportDataListener()

Excel处理类

返回:

ImportDataListener

importExcelClass

default Class<?> importExcelClass()

导入Excel处理类

返回:

Class

exportData

@GetMapping(value="/export")
 @RequestMapping(value="/export",
                method=POST,
                produces="application/octet-stream")
default void exportData(@RequestBody
                                                                                                                                                                         QueryDTO queryDTO,
                                                                                                                                                                         javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                  throws IOException

Excel导出数据

参数:

queryDTO - 查询参数

response - 响应

抛出:

IOException - IO异常

handlerExcelQueryList

default boolean handlerExcelQueryList(QueryDTO queryDTO,
                                      List<Entity> entityList)

自定义查询Excel数据

参数:

queryDTO - 查询参数

entityList - 数据列表

返回:

boolean

convertExcels

default List<ExcelEntity> convertExcels(List<Entity> entityList)

转换Excel表格

参数:

entityList - list数据

返回:

List

getFileName

default String getFileName()

获取文件名

返回:

String