阅读若依源码及查看文档,自己记录一下BaseController在开发中的使用,在Controller层开发中,继承BaseController,使用BaseController中的通用功能简化开发。
public class BaseController
{
protected final Logger logger = LoggerFactory.getLogger(BaseController.class);
@InitBinder
public void initBinder(WebDataBinder binder)
{
// Date 类型转换
binder.registerCustomEditor(Date.class, new PropertyEditorSupport()
{
@Override
public void setAsText(String text)
{
setValue(DateUtils.parseDate(text));
}
});
}
protected void startPage()
{
PageDomain pageDomain = TableSupport.buildPageRequest();
Integer pageNum = pageDomain.getPageNum();
Integer pageSize = pageDomain.getPageSize();
if (StringUtils.isNotNull(pageNum) && StringUtils.isNotNull(pageSize))
{
String orderBy = SqlUtil.escapeOrderBySql(pageDomain.getOrderBy());
PageHelper.startPage(pageNum, pageSize, orderBy);
}
}
@SuppressWarnings({ "rawtypes", "unchecked" })
protected TableDataInfo getDataTable(List> list)
{
TableDataInfo rspData = new TableDataInfo();
rspData.setCode(HttpStatus.SUCCESS);
rspData.setRows(list);
rspData.setTotal(new PageInfo(list).getTotal());
return rspData;
}
protected AjaxResult toAjax(int rows)
{
return rows > 0 ? AjaxResult.success() : AjaxResult.error();
}
}
Logger日志工具的使用
protected final Logger logger = LoggerFactory.getLogger(BaseController.class);
继承BaseController之后,即可直接再子类中使用logger实例对象打印日志,debug、info、warn、error、fatal,但比较常见的日志用法是Controller添加@Slf4j注解。
日期格式自动转换
@InitBinder
public void initBinder(WebDataBinder binder)
{
// Date 类型转换
binder.registerCustomEditor(Date.class, new PropertyEditorSupport()
{
@Override
public void setAsText(String text)
{
setValue(DateUtils.parseDate(text));
}
});
}
设置请求分页数据
若前端的分页参数、排序参数固定,则可以使用,getPageDomain中使用ServletUtils来获取前端传过来的分页及排序参数,ServletUtils底层使用的是RequestContextHolder来获取前端传递过来的参数。
public class TableSupport
{
public static final String PAGE_NUM = "pageNum";
public static final String PAGE_SIZE = "pageSize";
public static final String ORDER_BY_COLUMN = "orderByColumn";
public static final String IS_ASC = "isAsc";
public static PageDomain getPageDomain()
{
PageDomain pageDomain = new PageDomain();
pageDomain.setPageNum(ServletUtils.getParameterToInt(PAGE_NUM));
pageDomain.setPageSize(ServletUtils.getParameterToInt(PAGE_SIZE));
pageDomain.setOrderByColumn(ServletUtils.getParameter(ORDER_BY_COLUMN));
pageDomain.setIsAsc(ServletUtils.getParameter(IS_ASC));
return pageDomain;
}
public static PageDomain buildPageRequest()
{
return getPageDomain();
}
}
获取PageDomain实例对象,将分页及排序参数设置到PageHelper中, 只需要设置PageHelper.startPage(pageNum, pageSize, orderBy)即可在findAll()的时候得到分页数据,详情参考PageHelper的使用。
protected void startPage()
{
PageDomain pageDomain = TableSupport.buildPageRequest();
Integer pageNum = pageDomain.getPageNum();
Integer pageSize = pageDomain.getPageSize();
if (StringUtils.isNotNull(pageNum) && StringUtils.isNotNull(pageSize))
{
String orderBy = SqlUtil.escapeOrderBySql(pageDomain.getOrderBy());
PageHelper.startPage(pageNum, pageSize, orderBy);
}
}
响应请求分页数据
分页查询响应实体类TableDataInfo
public class TableDataInfo implements Serializable
{
private static final long serialVersionUID = 1L;
private long total;
private List> rows;
private int code;
private int msg;
public TableDataInfo()
{
}
public TableDataInfo(List> list, int total)
{
this.rows = list;
this.total = total;
}
public long getTotal()
{
return total;
}
public void setTotal(long total)
{
this.total = total;
}
public List> getRows()
{
return rows;
}
public void setRows(List> rows)
{
this.rows = rows;
}
public int getCode()
{
return code;
}
public void setCode(int code)
{
this.code = code;
}
public int getMsg()
{
return msg;
}
public void setMsg(int msg)
{
this.msg = msg;
}
}
getDataTable用于设置分页查询响应数据
@SuppressWarnings({ "rawtypes", "unchecked" })
protected TableDataInfo getDataTable(List> list)
{
TableDataInfo rspData = new TableDataInfo();
rspData.setCode(HttpStatus.SUCCESS);
rspData.setRows(list);
rspData.setTotal(new PageInfo(list).getTotal());
return rspData;
}
使用示例:
@RestController
@RequestMapping("/approval/completion")
public class ItProjectCompletionApprovalController extends BaseController
{
@GetMapping("/list")
public TableDataInfo list(ProjectDraftParam projectDraftParam)
{
//设置分页、排序参数
startPage();
//此处为按条件搜索,不带分页、排序参数
List list = IProjectDraftService.selectProjectDraftList(projectDraftParam);
//返回分页条件查询响应数据
return getDataTable(list);
}
}
响应返回结果(增删改)
用于增删改的响应,影响数据状态。
public class AjaxResult extends HashMap{ private static final long serialVersionUID = 1L; public static final String CODE_TAG = "code"; public static final String MSG_TAG = "msg"; public static final String DATA_TAG = "data"; public AjaxResult() { } public AjaxResult(int code, String msg) { super.put(CODE_TAG, code); super.put(MSG_TAG, msg); } public AjaxResult(int code, String msg, Object data) { super.put(CODE_TAG, code); super.put(MSG_TAG, msg); if (StringUtils.isNotNull(data)) { super.put(DATA_TAG, data); } } public static AjaxResult success() { return AjaxResult.success("操作成功"); } public static AjaxResult success(Object data) { return AjaxResult.success("操作成功", data); } public static AjaxResult success(String msg) { return AjaxResult.success(msg, null); } public static AjaxResult success(String msg, Object data) { return new AjaxResult(HttpStatus.SUCCESS, msg, data); } public static AjaxResult error() { return AjaxResult.error("操作失败"); } public static AjaxResult error(String msg) { return AjaxResult.error(msg, null); } public static AjaxResult error(String msg, Object data) { return new AjaxResult(HttpStatus.ERROR, msg, data); } public static AjaxResult error(int code, String msg) { return new AjaxResult(code, msg, null); } }
protected AjaxResult toAjax(int rows)
{
return rows > 0 ? AjaxResult.success() : AjaxResult.error();
}
使用示例:
@RestController
@RequestMapping("/approval/completion")
public class ItProjectCompletionApprovalController extends BaseController
{
@PostMapping
public AjaxResult add(@RequestBody ItProjectCompletionApproval itProjectCompletionApproval)
{
return toAjax(itProjectCompletionApprovalService.insertItProjectCompletionApproval(itProjectCompletionApproval));
}
}



