逆向工程文件example完美结合使用PageHelper分页插件

原生的mybatis需要手写sql语句，项目数据库表多了之后，可以让你写sql语句写到手软，于是mybatis官方提供了mybatis-generator：mybatis逆向工程代码生成工具，用于简化mybatis单表操作。

在PageHelper3.几的版本的时候，使用它对逆向工程生成的查询方法进行分页时出现失效的情况，而PageHelper4开始，亲测能够与mybatis逆向工程生成的方法完美兼容，今天就和大家分享spring+mybatis+PageHelper的一个整合小案例

第一步：创建maven工程，编写pom.xml

 <properties>
     <junit.version>4.12junit.version>
     <spring.version>4.3.10.RELEASEspring.version>

     <mybatis.version>3.4.1mybatis.version>

     <mybatis.spring.version>1.3.0mybatis.spring.version>
     <mysql.version>5.1.32mysql.version>
     <slf4j.version>1.6.4slf4j.version>

     <jackson.version>2.8.8jackson.version>

     <druid.version>1.0.9druid.version>
     <httpclient.version>4.3.5httpclient.version>
     <jstl.version>1.2jstl.version>
     <servlet-api.version>2.5servlet-api.version>
     <jsp-api.version>2.0jsp-api.version>
     <joda-time.version>2.5joda-time.version>
     <commons-lang3.version>3.3.2commons-lang3.version>
     <commons-io.version>1.3.2commons-io.version>
     <commons-net.version>3.3commons-net.version>

     <pagehelper.version>4.1.0pagehelper.version>

     <jsqlparser.version>0.9.1jsqlparser.version>
     <commons-fileupload.version>1.3.1commons-fileupload.version>
     <jedis.version>2.7.2jedis.version>
     <solrj.version>4.10.3solrj.version>
     <dubbo.version>2.5.3dubbo.version>
     <zookeeper.version>3.4.7zookeeper.version>
     <zkclient.version>0.1zkclient.version>
     <activemq.version>5.11.2activemq.version>
     <freemarker.version>2.3.23freemarker.version>
     <quartz.version>2.2.2quartz.version>
 properties>

 <dependencies>

     <dependency>
         <groupId>joda-timegroupId>
         <artifactId>joda-timeartifactId>
         <version>${joda-time.version}version>
     dependency>

     <dependency>
         <groupId>org.apache.commonsgroupId>
         <artifactId>commons-lang3artifactId>
         <version>${commons-lang3.version}version>
     dependency>
     <dependency>
         <groupId>org.apache.commonsgroupId>
         <artifactId>commons-ioartifactId>
         <version>${commons-io.version}version>
     dependency>
     <dependency>
         <groupId>commons-netgroupId>
         <artifactId>commons-netartifactId>
         <version>${commons-net.version}version>
     dependency>

     <dependency>
         <groupId>com.fasterxml.jackson.coregroupId>
         <artifactId>jackson-databindartifactId>
         <version>${jackson.version}version>
     dependency>

     <dependency>
         <groupId>org.apache.httpcomponentsgroupId>
         <artifactId>httpclientartifactId>
         <version>${httpclient.version}version>
     dependency>

     <dependency>
         <groupId>org.quartz-schedulergroupId>
         <artifactId>quartzartifactId>
         <version>${quartz.version}version>
     dependency>

     <dependency>
         <groupId>junitgroupId>
         <artifactId>junitartifactId>
         <version>${junit.version}version>
         <scope>testscope>
     dependency>


     <dependency>
         <groupId>org.mybatisgroupId>
         <artifactId>mybatisartifactId>
         <version>${mybatis.version}version>
     dependency>
     <dependency>
         <groupId>org.mybatisgroupId>
         <artifactId>mybatis-springartifactId>
         <version>${mybatis.spring.version}version>
     dependency>

     <dependency>
         <groupId>com.github.pagehelpergroupId>
         <artifactId>pagehelperartifactId>
         <version>${pagehelper.version}version>
     dependency>

     <dependency>
         <groupId>mysqlgroupId>
         <artifactId>mysql-connector-javaartifactId>
         <version>${mysql.version}version>
     dependency>

     <dependency>
         <groupId>com.alibabagroupId>
         <artifactId>druidartifactId>
         <version>${druid.version}version>
     dependency>

     <dependency>
         <groupId>org.springframeworkgroupId>
         <artifactId>spring-contextartifactId>
         <version>${spring.version}version>
     dependency>
     <dependency>
         <groupId>org.springframeworkgroupId>
         <artifactId>spring-beansartifactId>
         <version>${spring.version}version>
     dependency>
     <dependency>
         <groupId>org.springframeworkgroupId>
         <artifactId>spring-webmvcartifactId>
         <version>${spring.version}version>
     dependency>
     <dependency>
         <groupId>org.springframeworkgroupId>
         <artifactId>spring-jdbcartifactId>
         <version>${spring.version}version>
     dependency>
     <dependency>
         <groupId>org.springframeworkgroupId>
         <artifactId>spring-aspectsartifactId>
         <version>${spring.version}version>
     dependency>
     <dependency>
         <groupId>org.springframeworkgroupId>
         <artifactId>spring-jmsartifactId>
         <version>${spring.version}version>
     dependency>
     <dependency>
         <groupId>org.springframeworkgroupId>
         <artifactId>spring-context-supportartifactId>
         <version>${spring.version}version>
     dependency>

     <dependency>
            <groupId>org.springframeworkgroupId>
            <artifactId>spring-testartifactId>
            <version>${spring.version}version>
            <scope>providedscope>
     dependency>


     <dependency>
            <groupId>org.apache.logging.log4jgroupId>
            <artifactId>log4j-apiartifactId>
            <version>2.7version>
        dependency>
        <dependency>
            <groupId>org.apache.logging.log4jgroupId>
            <artifactId>log4j-coreartifactId>
            <version>2.7version>
        dependency>
     <dependency>
             <groupId>org.apache.logging.log4jgroupId>
             <artifactId>log4j-webartifactId>
             <version>2.7version>
        dependency>

     <dependency>
         <groupId>jstlgroupId>
         <artifactId>jstlartifactId>
         <version>${jstl.version}version>
     dependency>
     <dependency>
         <groupId>javax.servletgroupId>
         <artifactId>servlet-apiartifactId>
         <version>${servlet-api.version}version>
         <scope>providedscope>
     dependency>
     <dependency>
         <groupId>javax.servletgroupId>
         <artifactId>jsp-apiartifactId>
         <version>${jsp-api.version}version>
         <scope>providedscope>
     dependency>

     <dependency>
         <groupId>commons-fileuploadgroupId>
         <artifactId>commons-fileuploadartifactId>
         <version>${commons-fileupload.version}version>
     dependency>

     <dependency>
         <groupId>redis.clientsgroupId>
         <artifactId>jedisartifactId>
         <version>${jedis.version}version>
     dependency>

     <dependency>
         <groupId>org.apache.solrgroupId>
         <artifactId>solr-solrjartifactId>
         <version>${solrj.version}version>
     dependency>

     <dependency>
         <groupId>com.alibabagroupId>
         <artifactId>dubboartifactId>
         <version>${dubbo.version}version>
     dependency>
     <dependency>
         <groupId>org.apache.zookeepergroupId>
         <artifactId>zookeeperartifactId>
         <version>${zookeeper.version}version>
     dependency>
     <dependency>
         <groupId>com.github.sgroschupfgroupId>
         <artifactId>zkclientartifactId>
         <version>${zkclient.version}version>
     dependency>
     <dependency>
         <groupId>org.apache.activemqgroupId>
         <artifactId>activemq-allartifactId>
         <version>${activemq.version}version>
     dependency>
     <dependency>
         <groupId>org.freemarkergroupId>
         <artifactId>freemarkerartifactId>
         <version>${freemarker.version}version>
     dependency>
 dependencies>

     <build>
         <plugins>

         <plugin>
             <groupId>org.apache.maven.pluginsgroupId>
             <artifactId>maven-resources-pluginartifactId>
             <version>2.7version>
             <configuration>
                 <encoding>UTF-8encoding>
             configuration>
         plugin>

         <plugin>
             <groupId>org.apache.maven.pluginsgroupId>
             <artifactId>maven-compiler-pluginartifactId>
             <version>3.2version>
             <configuration>
                 <source>1.7source>
                 <target>1.7target>
                 <encoding>UTF-8encoding>
             configuration>
         plugin>

         <plugin>
             <groupId>org.apache.tomcat.mavengroupId>
             <artifactId>tomcat7-maven-pluginartifactId>
             <configuration>
                 <port>8080port>
                 <path>/path>
             configuration>
         plugin>
     plugins>
     build>

第二步：使用mybatis逆向工程工具生成代码:

mybatis-generator 下载地址： 逆向工程工具

该工具并不是我分享的，我也没用过，如果是不能用的，希望能够在评论区告诉我

第三步：将mybatis逆向工程生成的代码复制到我们的项目下

第四步：配置文件相关：

4.1 配置log4j2.xml文件

 xml version="1.0" encoding="UTF-8"?>
   <Configuration status="OFF" monitorInterval="1800">

       <properties>
           <property name="LOG_HOME">D:/log4j2/mybatis/genertor/logs/property>
           <property name="ERROR_LOG_FILE_NAME">errorproperty>
       properties>


       <Appenders>

           <Console name="Console" target="SYSTEM_OUT">
               <PatternLayout pattern="%d %-5p (%F:%L) - %m%n" />
           Console>

           <RollingRandomAccessFile name="ErrorLog"
                                    fileName="${LOG_HOME}/${ERROR_LOG_FILE_NAME}.log"
                                    filePattern="${LOG_HOME}/${ERROR_LOG_FILE_NAME}.log.%d{yyyy-MM-dd}.gz">
               <PatternLayout
                       pattern="%d %-5p (%F:%L) - %m%n"/>
               <Policies>

                   <TimeBasedTriggeringPolicy/>

                   <SizeBasedTriggeringPolicy size="100 MB"/>
               Policies>

               <DefaultRolloverStrategy max="20"/>
           RollingRandomAccessFile>
           <param name="Encoding" value="UTF-8" />
       Appenders>

       <Loggers>

           <logger name="org.springframework.core" level="info">
           logger>
           <logger name="org.springframework.beans" level="info">
           logger>
           <logger name="org.springframework.context" level="info">
           logger>
           <logger name="org.springframework.web" level="info">
           logger>
           <logger name="org.springframework.test.context.junit4.SpringJUnit4ClassRunner" level="info">
           logger>
           <logger name="com.lmsq.shaxuntech" level="debug" includeLocation="true" additivity="false">
               <appender-ref ref="ErrorLog"/>
               <appender-ref ref="Console"/>
           logger>

           <root level="info" includeLocation="true">
               <appender-ref ref="ErrorLog"/>
               <appender-ref ref="Console"/>
           root>
       Loggers>

   Configuration>

4.2配置spring相关配置文件

applicationContext-dao.xml

     <context:property-placeholder location="classpath:conf/db.properties" file-encoding="utf-8" />

     <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
         destroy-method="close">
         <property name="url" value="${jdbc.url}" />
         <property name="username" value="${jdbc.username}" />
         <property name="password" value="${jdbc.password}" />
         <property name="driverClassName" value="${jdbc.driver}" />
         <property name="maxActive" value="10" />
         <property name="minIdle" value="5" />
     bean>

     <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">

         <property name="dataSource" ref="dataSource" />

         <property name="configLocation" value="classpath:mybatis/SqlMapConfig.xml" />

         <property name="mapperLocations" value="classpath:mybatis/mapper/*.xml"/>
     bean>
     <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
         <property name="basePackage" value="com.stu.dao" />
     bean>

application-service.xml

     <context:component-scan base-package="com.stu.service"/>

springmvc.xml

     <context:property-placeholder location="classpath:conf/*.properties" file-encoding="utf-8" />

     <context:component-scan base-package="com.stu.api.controller" />
     <mvc:annotation-driven />


     <mvc:resources location="/css/" mapping="/css/**"/>
     <mvc:resources location="/js/" mapping="/js/**"/>



     <bean id="multipartResolver"
         class="org.springframework.web.multipart.commons.CommonsMultipartResolver">

         <property name="defaultEncoding" value="UTF-8">property>

         <property name="maxUploadSize" value="5242880">property>
     bean>



             <property name="dialect" value="mysql"/>
         plugin>
     plugins>

 configuration>

4.4 数据库链接的properties文件

 db.properties

 jdbc.driver=com.mysql.jdbc.Driver
 jdbc.url=jdbc:mysql://localhost:3306/stu?characterEncoding=utf-8
 jdbc.username=root
 jdbc.password=root

4.5web.xml的配置

 xml version="1.0" encoding="UTF-8"?>
 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">
   <display-name>Mybatis-generatordisplay-name>
   <welcome-file-list>
     <welcome-file>index.htmlwelcome-file>
     <welcome-file>index.htmwelcome-file>
     <welcome-file>index.jspwelcome-file>
     <welcome-file>default.htmlwelcome-file>
     <welcome-file>default.htmwelcome-file>
     <welcome-file>default.jspwelcome-file>
   welcome-file-list>


   <filter>
       <filter-name>characterEncodingfilter-name>
       <filter-class>org.springframework.web.filter.CharacterEncodingFilterfilter-class>
   <init-param>
       <param-name>encodingparam-name>
       <param-value>UTF-8param-value>
   init-param>
   filter>

   <filter-mapping>
       <filter-name>characterEncodingfilter-name>
       <url-pattern>/*url-pattern>
   filter-mapping>


      <listener>
         <listener-class>org.apache.logging.log4j.web.Log4jServletContextListenerlistener-class>
      listener>
      <filter>
          <filter-name>log4jServletFilterfilter-name>
         <filter-class>org.apache.logging.log4j.web.Log4jServletFilterfilter-class>
      filter>
      <filter-mapping>
          <filter-name>log4jServletFilterfilter-name>
          <url-pattern>/*url-pattern>
         <dispatcher>REQUESTdispatcher>
          <dispatcher>FORWARDdispatcher>
          <dispatcher>INCLUDEdispatcher>
          <dispatcher>ERRORdispatcher>
      filter-mapping>



      <filter>
         <filter-name>httpPutFormFilterfilter-name>
         <filter-class>org.springframework.web.filter.HttpPutFormContentFilterfilter-class>
     filter>
     <filter-mapping>
         <filter-name>httpPutFormFilterfilter-name>
         <url-pattern>/*url-pattern>
     filter-mapping>

   <listener>
      <listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class>
   listener>
   <context-param>
       <param-name>contextConfigLocationparam-name>
       <param-value>classpath:spring/applicationContext*.xmlparam-value>
   context-param>


   <servlet>
       <servlet-name>springmvcservlet-name>
       <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
       <load-on-startup>1load-on-startup>
        <init-param>
            <param-name>contextConfigLocationparam-name>
            <param-value>classpath:spring/springmvc.xmlparam-value>
        init-param>
   servlet>

   <servlet-mapping>
     <servlet-name>springmvcservlet-name>

     <url-pattern>/url-pattern>
   servlet-mapping>

 web-app>

第五步：创建service层引用Mapper接口

接口：

 package com.stu.service;

 import java.util.List;

 import com.stu.pojo.TUser;

 public interface UserService {

     public List getUserInfo( String keywords, Integer page, Integer size);

 }

实现类：

 package com.stu.service.impl;

 import java.util.List;

 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;

 import com.github.pagehelper.PageHelper;
 import com.github.pagehelper.PageInfo;
 import com.stu.dao.TUserMapper;
 import com.stu.pojo.TUser;
 import com.stu.pojo.TUserExample;
 import com.stu.service.UserService;
 @Service
 public class UserServiceImpl implements UserService {
     @Autowired
     private TUserMapper userMapper;

     @Override
     public List getUserInfo(String keywords, Integer page, Integer size) {
         PageHelper.startPage(page, size);
         TUserExample example = new TUserExample();
         if (!StringUtils.isBlank(keywords)) {
             example.createCriteria().andUsernameLike(keywords + "%");
         }
         List list = userMapper.selectByExample(example);
         PageInfo info = new PageInfo(list);
         System.out.println("页码: "  + info.getPageNum());
         System.out.println("每页大小: "  + info.getSize());
         System.out.println("总页数: "  + info.getPages());
         System.out.println("总记录数: "  + info.getTotal());
         return list;
     }

 }

注意:keywords是查询条件，对应表字段---->username

第六步：创建Controller

 package com.stu.api.controller;

 import java.io.UnsupportedEncodingException;
 import java.util.List;

 import javax.annotation.Resource;

 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;

 import com.stu.pojo.TUser;
 import com.stu.service.UserService;

 @RestController
 @RequestMapping("/api/v2/users")
 public class UserController {
     @Resource
     private UserService userService;

     @GetMapping("/")
     public List getUserInfo( String keywords ,Integer page, Integer size){
         System.out.println("page : " + page);
         System.out.println("size : " + size);
         if(keywords != null){
             try {
                 keywords=new String(keywords.getBytes("ISO-8859-1"),"UTF-8");
             } catch (UnsupportedEncodingException e) {
                 e.printStackTrace();
             }
         }
         List user = userService.getUserInfo(keywords , page, size);
         return user;
     }

 }

第七步：运行项目 ，测试

1、使用tomcat7:run运行项目

2、在浏览器中输入:http://localhost:8080/api/v2/users/?keyword=张三&page=1&size=2

数据返回成功:

 {"data":[{"id":1,"username":"王五","password":null,"state":0,"isdel":false,"addTime":1487644664000,"money":null,"leftMoney":22.1,"remark":null},{"id":2,"username":"张三","password":null,"state":0,"isdel":false,"addTime":1487644811000,"money":null,"leftMoney":22.1,"remark":null}],"meta":{"respCode":0,"respMsg":null,"detail":"OK","url":null},"pagination":{"page":1,"size":2,"totalPage":58,"totalCode":116}}