从头开始基于Maven搭建SpringMVC+Mybatis项目(3)

接上文内容，本节介绍基于Mybatis的查询和分页功能，并展示一个自定义的分页标签，可重复使用以简化JSP页面的开发。

从头阅读传送门

在上一节中，我们已经使用Maven搭建好了项目的基础结构，包括一个父项目petstore-parent和数据库持久层模块petstore-persist及Web站点petstore-web，现在来为petstore-web添加一些功能。对于初学者来说，可能第一个遇到的较复杂问题就是分页查询，那么就先从解决它开始。

看一下完成的效果：

上面是四个可选的查询条件，用户可以根据需要组合查询条件。

中间是符合条件的数据展示表格，对查询结果可以执行修改和删除操作，但是暂未实现。

最下面是一个分页导航栏，以自定义标签(Tag)技术实现，可复用到多个jsp页面。

下面来介绍关键步骤和代码。首先是petstore-persist模块，目录结构如下：

Product.Java是一个普通的JavaBean，这里略过。ProductMapper.java中定义了两个方法：

1. package com.example.petstore.persist.model;
2. import java.util.List;
3. import org.apache.ibatis.annotations.Param;
4. public interface ProductMapper {
5. /**
6. * 查询符合条件的记录总数
7. * @param id
8. * @param name
9. * @param fromPrice
10. * @param toPrice
11. * @return
12. */
13. int matches(@Param(value="id") int id, @Param(value="name") String name, @Param(value="fromPrice") float fromPrice, @Param(value="toPrice") float toPrice);
14. /**
15. * 按查询条件及分页条件分段查询记录
16. * @param id
17. * @param name
18. * @param fromPrice
19. * @param toPrice
20. * @param fetchIndex
21. * @param fetchCount
22. * @return
23. */
24. List<Product> findProducts(@Param(value="id") int id, @Param(value="name") String name, @Param(value="fromPrice") float fromPrice, @Param(value="toPrice") float toPrice, @Param(value="fetchIndex") int fetchIndex, @Param(value="fetchCount") int fetchCount);
25. }

使用时，首先调用matches方法获得符合条件的记录总数，然后根据每页显示的记录数和当前页数计算读取数据的Limit偏移量和记录数，再调用findProducts方法读取数据。两个方法的参数都使用了@Param注解，例如@Param(value="id") int id，在映射文件中，可通过#{id}的格式来使用这个参数。

在Product.xml中添加两个方法的SQL映射：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
3. <mapper namespace="com.example.petstore.persist.model.ProductMapper">
4. <resultMap type="com.example.petstore.persist.model.Product"
5. id="productMap">
6. <id column="p_id" property="id" />
7. <result column="p_name" property="name" />
8. <result column="p_price" property="price" />
9. </resultMap>
10. <select id="matches" resultType="int">
11. select count(*) from t_product
12. <where>
13. <if test="id>0">
14. p_id=#{id}
15. </if>
16. <if test="name!=null and name!='' ">
17. and locate(#{name},p_name)>0
18. </if>
19. <if test="fromPrice>-1">
20. and p_price>=#{fromPrice}
21. </if>
22. <if test="toPrice>-1">
23. and p_price<=#{toPrice}
24. </if>
25. </where>
26. </select>
27. <select id="findProducts" resultMap="productMap">
28. select * from t_product
29. <where>
30. <if test="id>0">
31. p_id=#{id}
32. </if>
33. <if test="name!=null and name!='' ">
34. and locate(#{name},p_name)>0
35. </if>
36. <if test="fromPrice>-1">
37. and p_price>=#{fromPrice}
38. </if>
39. <if test="toPrice>-1">
40. and p_price<=#{toPrice}
41. </if>
42. </where>
43. limit #{fetchIndex},#{fetchCount}
44. </select>
45. </mapper>

可以看到上面两个方法中，就是通过<where><if>等元素来组装查询SQL。Mybatis的优点之一就是直接使用SQL语法，有SQL基础的情况下非常容易上手。

下面进入petstore-web模块，先来看整体结构：

其中com.example.petstore.web.tag.PagingTag.java是分页标签类，关键代码：

1. private int pageIndex = 1;  //当前页数
2. private int pageSize = 20;  //默认每页行数
3. private int pageCount = 0;  //记录总页数
4. private int itemCount = 0;  //记录总条数
5. private int numCount = 10;  //分页栏数字导航链接个数
6. @Override
7. public void doTag() throws JspException, IOException {
8. JspWriter out = this.getJspContext().getOut();
9. out.write("<script type=\"text/javascript\">function navigatorPage(pageIndex) {document.getElementById('pageIndex').value = pageIndex;document.forms[0].submit();}</script>");
10. out.write("每页显示");
11. out.write("<select id='pageSize' name='pageSize' onchange='navigatorPage(" + pageIndex + ")'>");
12. out.write("<option value='5'" + (pageSize == 5 ? " selected='true'" : "") + ">5</option>");
13. out.write("<option value='10'" + (pageSize == 10 ? " selected='true'" : "") + ">10</option>");
14. out.write("<option value='20'" + (pageSize == 20 ? " selected='true'" : "") + ">20</option>");
15. out.write("<option value='50'" + (pageSize == 50 ? " selected='true'" : "") + ">50</option>");
16. out.write("<option value='100'" + (pageSize == 100 ? " selected='true'" : "") + ">100</option>");
17. out.write("<option value='500'" + (pageSize == 500 ? " selected='true'" : "") + ">500</option>");
18. out.write("</select>");
19. out.write("条    ");
20. out.write(pageIndex + "/" + pageCount + "页    ");
21. out.write("共" + itemCount + "条记录    ");
22. out.write("<input type='button' value='第一页' onclick='javascript:navigatorPage(1);'" + (pageIndex > 1 ? "" : " disabled='true'") + " />  ");
23. out.write("<input type='button' value='上一页' onclick='javascript:navigatorPage(" + (pageIndex - 1) + ");'" + (pageIndex > 1 ? "" : " disabled='true'") + " />  ");
24. //数字导航栏
25. int iStartIndex = 1;
26. int iEndIndex = pageCount;
27. if(pageCount <= numCount) {
28. } else if ((pageIndex + (numCount + 1) / 2) > pageCount) {
29. iStartIndex = pageCount - (numCount - 1);
30. iEndIndex = pageCount;
31. } else if (pageIndex <= (numCount + 1) / 2) {
32. iEndIndex = numCount;
33. } else {
34. if (numCount % 2 == 0) {
35. iStartIndex = pageIndex - numCount / 2;
36. iEndIndex = pageIndex + (numCount - 1) / 2;
37. } else {
38. iStartIndex = pageIndex - numCount / 2;
39. iEndIndex = pageIndex + numCount / 2;
40. }
41. }
42. for(int i = iStartIndex; i <= iEndIndex; i++) {
43. if(i == pageIndex) {
44. out.write("<strong>" + i + "</strong>  ");
45. } else {
46. out.write("<a href='javascript:navigatorPage(" + i + ");'>" + i + "</a>  ");
47. }
48. }
49. out.write("<input type='button' value='下一页' onclick='javascript:navigatorPage(" + (pageIndex + 1) + ");'" + (pageIndex < pageCount ? "" : " disabled='true'") + " />  ");
50. out.write("<input type='button' value='最后页' onclick='javascript:navigatorPage(" + pageCount + ");'" + (pageIndex < pageCount ? "" : " disabled='true'") + " />");
51. out.write("<input type='hidden' id='pageIndex' name='pageIndex' value='" + pageIndex + "'/>");
52. }

接下来还需要一个标签配置文件来声明这个标签的使用方法。

在WEB-INF下建立目录tld，然后添加pagingTag.tld，内容如下：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <!DOCTYPE taglib
3. PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
4. "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
5. <taglib>
6. <tlib-version>2.0</tlib-version>
7. <jsp-version>1.2</jsp-version>
8. <short-name>Paging</short-name>
9. <uri>http://blog.csdn.net/autfish/tag/</uri>
10. <display-name>Paging Tag</display-name>
11. <description>Paging Tag library</description>
12. <tag>
13. <name>pagingTag</name>
14. <tag-class>com.example.petstore.web.tag.PagingTag</tag-class>
15. <body-content>empty</body-content>
16. <description>create navigation for paging</description>
17. <attribute>
18. <name>pageIndex</name>
19. <rtexprvalue>true</rtexprvalue>
20. </attribute>
21. <attribute>
22. <name>pageSize</name>
23. <rtexprvalue>true</rtexprvalue>
24. </attribute>
25. <attribute>
26. <name>pageCount</name>
27. <rtexprvalue>true</rtexprvalue>
28. </attribute>
29. <attribute>
30. <name>itemCount</name>
31. <rtexprvalue>true</rtexprvalue>
32. </attribute>
33. </tag>
34. </taglib>

注意其中的uri元素，这里并不需要配置真实存在的url，但该uri在你的classpath中应保持唯一，不能被其他组件声明使用。

在web.xml中启用这个标签：

1. <jsp-config>
2. <taglib>
3. <taglib-uri>http://blog.csdn.net/autfish/tag/</taglib-uri>
4. <taglib-location>/WEB-INF/tld/pagingTag.tld</taglib-location>
5. </taglib>
6. </jsp-config>

在jsp中使用：

1. <%@ taglib prefix="my" uri="http://blog.csdn.net/autfish/tag/" %>

1. <my:pagingTag pageIndex="${contentModel.pageIndex}" pageSize="${contentModel.pageSize}" pageCount="${contentModel.pageCount}" itemCount="${contentModel.itemCount}" />

对于四个属性的赋值，contentModel是一个PagingList.java类的实例，用于辅助分页，由分页属性和数据表构成，在Controller中填充数据并传递到视图JSP。属性如下：

1. private int pageIndex = 1;
2. private int pageSize = 20;
3. private int pageCount = 0;
4. private int itemCount = 0;
5. private List<T> items;

Controller代码：

1. @Controller
2. @RequestMapping("/product")
3. public class ProductController {
4. @Autowired
5. private ProductService productService;
6. @RequestMapping(value="/list")
7. public String listProduct(Model model, @ModelAttribute("searchModel") SearchModel formModel,
8. @RequestParam(value=PagingList.PAGE_INDEX_NAME, defaultValue="1") int pageIndex,
9. @RequestParam(value=PagingList.PAGE_SIZE_NAME, defaultValue="10") int pageSize) {
10. int id = 0;
11. String name = "";
12. float fromPrice = -1;
13. float toPrice = -1;
14. if(formModel != null) {
15. id = NumberUtils.toInt(formModel.getId(), 0);
16. name = formModel.getName();
17. fromPrice = NumberUtils.toFloat(formModel.getFromPrice(), -1);
18. toPrice = NumberUtils.toFloat(formModel.getToPrice(), -1);
19. }
20. model.addAttribute("searchModel", formModel);
21. PagingList<Product> contentModel = this.productService.findProducts(id, name, fromPrice, toPrice, pageIndex, pageSize);
22. model.addAttribute("contentModel", contentModel);
23. return "product/list";
24. }
25. }

Controller中注入了一个ProductService的实例，用于管理持久层的调用，主要代码如下：

1. @Service
2. public class ProductServiceStdImpl implements ProductService {
3. @Autowired
4. private ProductMapper productMapper;
5. @Override
6. public PagingList<Product> findProducts(int id, String name,
7. float fromPrice, float toPrice, int pageIndex, int pageSize) {
8. int total = this.productMapper.matches(id, name, fromPrice, toPrice);
9. int pageCount = total % pageSize == 0 ? total / pageSize : total / pageSize + 1;
10. if(pageIndex > pageCount)
11. pageIndex = pageCount;
12. int fetchIndex = (pageIndex - 1) * pageSize;
13. int fetchCount = fetchIndex + pageSize > total ? (total - fetchIndex) : pageSize;
14. List<Product> list = this.productMapper.findProducts(id, name, fromPrice, toPrice, fetchIndex, fetchCount);
15. PagingList<Product> paging = new PagingList<Product>();
16. paging.setItemCount(total);
17. paging.setPageCount(pageCount);
18. paging.setPageIndex(pageIndex);
19. paging.setPageSize(pageSize);
20. paging.setItems(list);
21. return paging;
22. }
23. }

限于篇幅，不能把所有的源码一一粘贴，有兴趣可以下载源码。

在WEB容器如tomcat中运行petstore-web模块，使用http://localhost:8080/petstore-web/product/list访问，顺利的话就看到了一开始的画面。如果出错，比对源码检查差异即可。

总结

分页查询功能使用频繁，且开发比较复杂，按需定制一套可复用的分页组件对提高开发效率有很大的帮助。下一节我们继续完善Web模块，增加增删改查以及权限控制功能。

本节源码下载