自动生成接口的 Service 方法描述及使用文档
优质
小牛编辑
127浏览
2023-12-01
自动生成接口的Service方法共有七个,分别为create,delete,update,get,getListWithPagingAndFilter,getListWithPagingAndFilter,countListWithPagingAndFilter
文档中入pageNo,pageSize,sortItem,sortOrder,filters,includes,refers,relates的使用方法详见swagger接口测试文档。
service方法的介绍
create
int create(Product item);
create为创建方法,传入需要创建的对象
该方法在自动生成代码中的应用:
productService.create(item);
delete
int delete(String id);
delete为删除方法,传入需要删除的对象的id
该方法在自动生成代码中的应用:
productService.delete(id);
update
int update(Product item);
update为更新方法,传入需要更新的对象
该方法在自动生成代码中的应用:
productService.update(item);
get
Product get(String id);
get为获得单条数据的查询方法,需要传入要查询对象的id,返回查询的对象内容
该方法在自动生成代码中的应用:
Product item = productService.get(id);
getListWithPagingAndFilter
List
<
Product
>
getListWithPagingAndFilter(Integer pageNo,
Integer pageSize,
String sortItem,
String sortItem,
String filters);
此方法为查询对象列表方法,传入pageNo,pageSize,sortItem,sortItem以及要过滤的filters条件,来获得符合过滤条件的对象列表
该方法的应用:
return productService.getListWithPagingAndFilter(
pageNo, pageSize, sortItem, sortOrder, filters);
getListWithPagingAndFilter
Object getListWithPagingAndFilter(Integer pageNo, Integer pageSize,
String sortItem, String sortOrder,
String filters,
String includes,
String refers,
String relates);
此方法为返回Object对象的列表查询方法,需要传入pageNo,pageSize,sortItem,sortOrder,filters,includes,refers,relates,来获得符合条件的对象列表及关联表对象列表
该方法在自动生成代码中的应用:
return productService.getListWithPagingAndFilter(
pageNo, pageSize, sortItem, sortOrder, filters, includes, refers, relates);
countListWithPagingAndFilter
Long countListWithPagingAndFilter(String filters);
此方法为列表计数方法,需要出入过滤的filters条件,来获得该过滤条件下查询获得的列表条数
该方法在自动生成生成代码中的应用:
Long total = productService.countListWithPagingAndFilter(filters);
response.addHeader("total", String.valueOf(total));