作一个不复制粘贴的程序员[1]: 使用模板方法模式（1）- 分页查询实例
对于重复的代码，若是是重复的字符串，咱们会想到提出一个变量。若是是重复的代码块，咱们会想到提取出一个方法。html
但若是这重复的代码块中有一处或几处是会变化的，那么就没那么容易提取出一个方法。提及来有点抽象，下面看一个例子。前端
1、分页查询
写过CRUD的同窗确定写过不少分页查询，分页查询的主要步骤是先校验前端传过来的查询条件（包括哪一页以及每页显示记录数等），若是不合法则设置默认值。而后根据条件查询符合条件的总记录数，以及查询符合条件的一页记录，最后通过处理返回给前端。java
这一段话中会变的部分，也就是每一个分页查询不一样的部分，就是两个查询。这不就是一个模板，对于不一样的分页查询，只要往其中填两块代码。算法
不过有的同窗可能会说平时用分页插件，不须要写查询总数的方法，不过有时仍是须要本身写查询总数的方法来优化SQL滴。sql
2、Java8以前的方式
下面是一些核心类app
/**
* 分页查询结果对象
*
* @param <T> 分页查询对象类型
*/
@AllArgsConstructor
@Getter
@ToString
public final class Page<T> implements Serializable {
/**
* 总记录数
*/
@NonNull
private final Long total;
/**
* 当前记录集合
*/
@NonNull
private final List<T> rows;
}
/**
* 分页查询模板（Java8以前的写法）
*/
public abstract class AbstractPageTemplate<E> {
/**
* "pageNumber"
*/
public static final String PAGE_NUMBER = "pageNumber";
/**
* "pageSize"
*/
public static final String PAGE_SIZE = "pageBegin";
/**
* "pageBegin"
*/
private static final String PAGE_BEGIN = "pageBegin";
/**
* 获取分页结果对象
* <p>
* 示例:
*
* <pre>
* {@code
* Page<FooDTO> fooDTOPage = PageUtil.page(mapper::selectPageCount1, mapper::selectPageEntities1, paramMap)
* }
* </pre>
*
* @param paramMap 分页查询参数（key须要包含”pageNumber“和”pageSize“，不然默认查询第一页的20条记录）
* @return 分页结果对象集合
*/
public Page<E> page(Map<String, Object> paramMap) {
Objects.requireNonNull(paramMap);
// 获取页数
Integer pageNumber = (Integer) paramMap.get(PAGE_NUMBER);
// 校验页数，不合法则设置默认值
pageNumber = pageNumber == null || pageNumber <= 0 ? 1 : pageNumber;
// 获取页大小，不合法设置默认值
Integer pageSize = (Integer) paramMap.computeIfAbsent(PAGE_SIZE, k -> 20);
// 计算SQL中limit的offset（Mysql）
paramMap.put(PAGE_BEGIN, (pageNumber - 1) * pageSize);
// 查询符合条件的总记录数
long total = pageCount(paramMap);
if (total <= 0) {
return new Page<>(0L, new ArrayList<>());
} else {
// 查询符合条件的一页记录
return new Page<>(total, pageList(paramMap));
}
}
/**
* 查询符合条件的总记录数
*
* @param paramMap 分页查询参数（key须要包含”pageNumber“和”pageSize“，不然默认查询第一页的20条记录）
* @return 总记录数
*/
abstract long pageCount(Map<String, Object> paramMap);
/**
* 查询符合条件的全部记录
*
* @param paramMap 分页查询参数（key须要包含”pageNumber“和”pageSize“，不然默认查询第一页的20条记录）
* @return 分页结果集合
*/
abstract List<E> pageList(Map<String, Object> paramMap);
}
下面是一些为demo准备的类框架
@Data
public class User {
}
public class UserDAO {
public long pageCount(Map<String, Object> paramMap) {
// select count(*) from user where ...
return 0;
}
public List<User> pageList(Map<String, Object> paramMap) {
// select * from user where ... limit pageBegin, pageSize
return new ArrayList<>();
}
}
public class UserService extends AbstractPageTemplate<User> {
private UserDAO userDAO = new UserDAO();
@Override
public long pageCount(Map<String, Object> paramMap) {
return userDAO.pageCount(paramMap);
}
@Override
public List<User> pageList(Map<String, Object> paramMap) {
return userDAO.pageList(paramMap);
}
}
下面是demoide
UserService userService = new UserService();
Page<User> userPage = userService.page(ImmutableMap.of(
PageUtil.PAGE_NUMBER, 1,
PageUtil.PAGE_SIZE, 20
// 其余参数...
));
分析下上面这种传统的模板方法模式，咱们把样板式的代码写到AbstractPageTemplate#page()方法中，当咱们要写新的分页查询时，只要继承AbstractPageTemplate类，而后实现其中的两个方法，就能够很方便的获取到分页结果。工具
若是没有想到模板方法模式，项目中确定会有大量的相似于AbstractPageTemplate#page()方法中的代码，并且每一个人写的可能会不同，若是后面要修改默认的每页大小，要找到全部的这些分页代码不是很容易，不免会有遗漏。模板方法模式为后期的重构、扩展提供了便利。优化
这种传统的方式写起来有点麻烦，一个模块有几个分页查询就要写几个Service类，去继承AbstractPageTemplate类。一个模块有多个service好像有点不合理，若是能把AbstractPageTemplate#pageCount方法和AbstractPageTemplate#pageList方法做为方法参数传入AbstractPageTemplate#page()方法中，那么就方便多了，不用再去写那么多Service类了。还好Java8以后有了lambda表达式，咱们就能够把方法做为方法的参数。
3、Java8的方式
下面是核心类
/**
* 分页查询工具类
*/
public class PageUtil {
/**
* "pageNumber"
*/
public static final String PAGE_NUMBER = "pageNumber";
/**
* "pageSize"
*/
public static final String PAGE_SIZE = "pageSize";
/**
* "pageBegin"
*/
private static final String PAGE_BEGIN = "pageBegin";
private PageUtil() {
}
/**
* 获取分页结果对象
* <p>
* 示例:
*
* <pre>
* {@code
* Page<FooDTO> fooDTOPage = PageUtil.page(mapper::selectPageCount1, mapper::selectPageEntities1, paramMap)
* }
* </pre>
*
* @param pageCountFunction 查询分页总数的方法（参数类型：{@code Map<String, Object>}；返回值类型：{@code int}）
* @param pageQueryListFunction 查询分页记录的方法（参数类型：{@code Map<String, Object>};；返回值类型：{@code List<E>}）
* @param paramMap 分页查询参数（key须要包含”pageNumber“和”pageSize“，不然默认查询第一页的20条记录）
* @return 分页结果对象集合
*/
public static <E> Page<E> page(ToLongFunction<Map<String, Object>> pageCountFunction,
Function<Map<String, Object>, List<E>> pageQueryListFunction,
Map<String, Object> paramMap) {
Objects.requireNonNull(pageCountFunction);
Objects.requireNonNull(pageQueryListFunction);
Objects.requireNonNull(paramMap);
Integer pageNumber = (Integer) paramMap.get(PAGE_NUMBER);
pageNumber = pageNumber == null || pageNumber <= 0 ? 1 : pageNumber;
Integer pageSize = (Integer) paramMap.computeIfAbsent(PAGE_SIZE, k -> 20);
paramMap.put(PAGE_BEGIN, (pageNumber - 1) * pageSize);
long total = pageCountFunction.applyAsLong(paramMap);
if (total <= 0) {
return new Page<>(0L, new ArrayList<>());
} else {
return new Page<>(total, pageQueryListFunction.apply(paramMap));
}
}
}
下面是demo
Page<User> userPage = PageUtil.page(userService::pageCount, userService::pageList, ImmutableMap.of(
PageUtil.PAGE_NUMBER, 1,
PageUtil.PAGE_SIZE, 20
// 其余参数...
));
分析下Java8之后的写法，对于一个模块有多个分页查询的状况，咱们只要在Service中定义多个“查询符合条件的总记录数”和“查询符合条件的全部记录”的方法，而后在PageUtil#page方法中传入方法引用。
归纳来讲，Java8之后咱们就能够把方法做为方法的参数传入方法中，从而省去了写不少类去继承抽象的模板类的麻烦。
4、模板方法模式
模板方法模式是一个在咱们平时写代码中常常用到的模式，能够帮咱们少写不少重复的代码，从而提升开发效率。在一些框架中也会常常看到，好比Spring的JdbcTemplate。GOF给模板方法模式下过如下定义：
定义一个操做中的算法骨架，而将一些步骤迟到子类中。模板方法使得子类能够不改变一个算法的结构便可重定义该算法的某些特定步骤。
若是你不明白这个定义也无所谓，只要你看懂了上面那个Java8的例子就能够了。在我看来，模板方法模式就是把方法传入方法中，有了lambda，就是把把方法做为方法参数传入方法中。
回到本系列的目录
- 1. 作一个不复制粘贴的程序员[0]: 概述
- 2. 作一个不复制粘贴的程序员[1]: 使用模板方法模式（2）- 对象更新比较器实例
- 3. vim复制粘贴系统粘贴板
- 4. 前端操作复制粘贴板(clicpboardData )
- 5. Oracle 分页查询的一个实例
- 6. js/jquery经常使用方法------复制粘贴至剪切板
- 7. 模板模式，程序员的一天
- 8. 程序员的表白模板制作
- 9. 小程序组件库ColorUI的使用，一键复制粘贴
- 10. Android复制粘贴
- 更多相关文章...
- • Eclipse 代码模板 - Eclipse 教程
- • Maven 项目模板 - Maven教程
- • 委托模式
- • 常用的分布式事务解决方案
-
每一个你不满意的现在，都有一个你没有努力的曾经。