Package net.guerlab.cloud.web.provider

Class BaseQueryController<E extends net.guerlab.cloud.commons.entity.IBaseEntity,Q extends net.guerlab.cloud.searchparams.SearchParams,A extends net.guerlab.cloud.commons.api.QueryApi<E,Q>,V>

java.lang.Object

net.guerlab.cloud.web.provider.BaseQueryController<E,Q,A,V>

Type Parameters:

E - 实体类型

Q - 搜索参数类型

A - api接口类型

V - 返回对象类型

Direct Known Subclasses:

BaseManageController

public abstract class BaseQueryController<E extends net.guerlab.cloud.commons.entity.IBaseEntity,Q extends net.guerlab.cloud.searchparams.SearchParams,A extends net.guerlab.cloud.commons.api.QueryApi<E,Q>,V>
extends Object

基础查询控制器实现.

Author:

guer

Field Summary

Fields

Modifier and Type	Field	Description
protected final A	api	api.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseQueryController(A api)	根据api实例创建控制器.

Method Summary

Modifier and Type	Method	Description
protected void	afterFind(Collection<V> list, Q searchParams)	查询后置焕然.
protected boolean	beforeFind(Q searchParams)	查询前置环绕.
protected abstract V	convert(E entity)	实体对象转换为输出对象.
protected void	entityCheck(E entity)	对象检查.
protected RuntimeException	nullPointException()	当对象为空的时候抛出的异常.
V	selectById(Long id, Q searchParams)	通过Id查询单一结果.
long	selectCount(Q searchParams)	查询总记录数.
List<V>	selectList(Q searchParams)	查询列表.
V	selectOne(Q searchParams)	查询单一结果.
net.guerlab.cloud.core.result.Pageable<V>	selectPage(Q searchParams, int pageId, int pageSize)	查询分页列表.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

api

protected final A extends net.guerlab.cloud.commons.api.QueryApi<E,Q> api

api.

Constructor Details

BaseQueryController

protected BaseQueryController(A api)

根据api实例创建控制器.

Parameters:

api - api实例

Method Details

convert

protected abstract V convert(E entity)

实体对象转换为输出对象.

Parameters:

entity - 实体对象

Returns:

输出对象

selectById

@Nullable
@GetMapping("/{id:\\d+}")
public V selectById(@PathVariable("id")
 Long id,
 @Nullable
 Q searchParams)

通过Id查询单一结果.

Parameters:

id - ID

searchParams - 搜索参数

Returns:

实体数据

selectOne

@Nullable
@PostMapping("/search/one")
public V selectOne(@RequestBody
 Q searchParams)

查询单一结果.

Parameters:

searchParams - 搜索参数对象

Returns:

实体数据

entityCheck

protected void entityCheck(E entity)

对象检查.

Parameters:

entity - 实体

nullPointException

protected RuntimeException nullPointException()

当对象为空的时候抛出的异常.

Returns:

当对象为空的时候抛出的异常

selectList

@PostMapping("/search/list")
public List<V> selectList(@RequestBody
 Q searchParams)

查询列表.

Parameters:

searchParams - 搜索参数对象

Returns:

列表

selectPage

@PostMapping("/search/page")
public net.guerlab.cloud.core.result.Pageable<V> selectPage(@RequestBody
 Q searchParams,
 @RequestParam(name="pageId",defaultValue="1",required=false)
 int pageId,
 @RequestParam(name="pageSize",defaultValue="10",required=false)
 int pageSize)

查询分页列表.

Parameters:

searchParams - 搜索参数对象

pageId - 分页ID

pageSize - 分页尺寸

Returns:

分页结果

selectCount

@PostMapping("/search/count")
public long selectCount(@RequestBody
 Q searchParams)

查询总记录数.

Parameters:

searchParams - 搜索参数对象

Returns:

总记录数

beforeFind

protected boolean beforeFind(Q searchParams)

查询前置环绕.

Parameters:

searchParams - 搜索参数

Returns:

是否继续查询

afterFind

protected void afterFind(Collection<V> list,
 @Nullable
 Q searchParams)

查询后置焕然.

Parameters:

list - 结果列表

searchParams - 搜索参数