❄️ feat(分页插件): 添加Mybatis分页插件PageHelper

Author: coderqianlq

service-customer/pom.xml

@@ -100,6 +100,13 @@
             <version>1.3.2</version>
         </dependency>
 
+        <!-- 引入PageHelper依赖 -->
+        <dependency>
+            <groupId>com.github.pagehelper</groupId>
+            <artifactId>pagehelper-spring-boot-starter</artifactId>
+            <version>1.2.3</version>
+        </dependency>
+
         <!-- 引入Mybatis-Plus依赖 -->
         <!--<dependency>-->
             <!--<groupId>com.baomidou</groupId>-->

service-customer/src/main/java/com/coderqian/eurekacustomer/controller/TestController.java

@@ -4,6 +4,7 @@
 import com.coderqian.eurekacustomer.service.TestService;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.cloud.context.config.annotation.RefreshScope;
@@ -26,33 +27,33 @@
 @Api(value = "测试", description = "测试模块", position = 1)
 public class TestController {
 
-//    @Value("${profile}")
+    //    @Value("${profile}")
     private String profile;
 
     @Autowired
     private TestService testService;
 
     @ApiOperation(value = "返回用户输入的结果", notes = "返回用户输入的结果")
     @RequestMapping(value = "/result", method = RequestMethod.GET)
-    public String test(@RequestParam(value = "text") String text) {
+    public String test(@ApiParam(value = "测试内容", required = true) @RequestParam(value = "text") String text) {
         return testService.test(text);
     }
 
     @ApiOperation(value = "测试全局异常捕获", notes = "测试全局异常捕获")
     @RequestMapping(value = "/exception", method = RequestMethod.GET)
-    public void testException(@RequestParam(value = "text") String text) {
+    public void testException(@ApiParam(value = "测试内容", required = true) @RequestParam(value = "text") String text) {
         testService.testException(text);
     }
 
     @ApiOperation(value = "返回统一的baseResult", notes = "返回统一的baseResult，推荐使用这种方式，所有的返回结果统一用baseResult组装")
-    @RequestMapping(value = "/baseresult", method = RequestMethod.GET)
-    public BaseResult testBaseResult(@RequestParam(value = "text") String text) {
+    @RequestMapping(value = "/baseResult", method = RequestMethod.GET)
+    public BaseResult testBaseResult(@ApiParam(value = "测试内容", required = true) @RequestParam(value = "text") String text) {
         return testService.testBaseResult(text);
     }
 
     @ApiOperation(value = "根据用户id获取用户信息", notes = "根据用户id获取用户信息")
     @RequestMapping(value = "/find", method = RequestMethod.GET)
-    public BaseResult testMybatis(@RequestParam("id") String id) {
+    public BaseResult testMybatis(@ApiParam(value = "用户id", required = true) @RequestParam("id") String id) {
         return testService.testMybatis(id);
     }
 
@@ -61,4 +62,11 @@ public BaseResult testMybatis(@RequestParam("id") String id) {
     public String testBus() {
         return profile;
     }
+
+    @ApiOperation(value = "测试分页插件", notes = "测试分页插件")
+    @RequestMapping(value = "/page", method = RequestMethod.GET)
+    public BaseResult testPage(@ApiParam(value = "当前页码", required = true) @RequestParam("pageNum") Integer pageNum,
+                               @ApiParam(value = "每页长度", required = true) @RequestParam("pageSize") Integer pageSize) {
+        return testService.testPageHelper(pageNum, pageSize);
+    }
 }

service-customer/src/main/java/com/coderqian/eurekacustomer/mapper/UserMapper.java

@@ -3,6 +3,8 @@
 import com.coderqian.eurekacustomer.entity.User;
 import org.apache.ibatis.annotations.Mapper;
 
+import java.util.List;
+
 /**
  * @author qianliqing
  * @date 2018-10-02 下午2:31
@@ -12,11 +14,18 @@
 @Mapper
 public interface UserMapper {
 
+    /**
+     * 查询所有用户
+     *
+     * @return List<User>
+     */
+    List<User> findAll();
+
     /**
      * 根据用户id查询
      *
      * @param id 用户id
-     * @return
+     * @return User
      */
     User findUserById(String id);
 }

service-customer/src/main/java/com/coderqian/eurekacustomer/service/TestService.java

@@ -14,31 +14,40 @@ public interface TestService {
      * 测试接口
      *
      * @param text 测试数据
-     * @return
+     * @return String
      */
     String test(String text);
 
     /**
      * 测试接口
      *
      * @param text 测试数据
-     * @return
+     * @return void
      */
     void testException(String text);
 
     /**
      * 测试接口
      *
      * @param text 测试数据
-     * @return
+     * @return BaseResult
      */
     BaseResult testBaseResult(String text);
 
     /**
      * 测试mybatis接口
      *
      * @param id 用户id
-     * @return
+     * @return BaseResult
      */
     BaseResult testMybatis(String id);
+
+    /**
+     * 测试Mybatis分页插件
+     *
+     * @param pageNum  当前页码
+     * @param pageSize 每页长度
+     * @return BaseResult
+     */
+    BaseResult testPageHelper(Integer pageNum, Integer pageSize);
 }

service-customer/src/main/java/com/coderqian/eurekacustomer/service/impl/TestServiceImpl.java

@@ -4,11 +4,16 @@
 import com.coderqian.eurekacustomer.common.BaseResultFactory;
 import com.coderqian.eurekacustomer.common.constant.Code;
 import com.coderqian.eurekacustomer.common.exception.BusinessException;
+import com.coderqian.eurekacustomer.entity.User;
 import com.coderqian.eurekacustomer.mapper.UserMapper;
 import com.coderqian.eurekacustomer.service.TestService;
+import com.github.pagehelper.PageHelper;
+import com.github.pagehelper.PageInfo;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
+import java.util.List;
+
 /**
  * @author qianliqing
  * @date 2018-09-28 下午2:39
@@ -40,4 +45,12 @@ public BaseResult testBaseResult(String text) {
     public BaseResult testMybatis(String id) {
         return BaseResultFactory.createSuccessResult(userMapper.findUserById(id));
     }
+
+    @Override
+    public BaseResult testPageHelper(Integer pageNum, Integer pageSize) {
+        PageHelper.startPage(pageNum, pageSize);
+        List<User> users = userMapper.findAll();
+        PageInfo<User> page = new PageInfo<>(users);
+        return BaseResultFactory.createSuccessResult(page);
+    }
 }

service-customer/src/main/resources/application.properties

@@ -24,4 +24,9 @@ spring.datasource.filters=stat,wall
 logging.config=classpath:log4j2.xml
 
 mybatis.mapper-locations=classpath:mapper/*.xml
-mybatis.config-location=classpath:config/mybatis-config.xml
+mybatis.config-location=classpath:config/mybatis-config.xml
+
+pagehelper.helperDialect=mysql
+pagehelper.reasonable=true
+pagehelper.supportMethodsArguments=true
+pagehelper.params=count=countSql

service-customer/src/main/resources/mapper/UserMapper.xml

@@ -2,7 +2,23 @@
 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
 <mapper namespace="com.coderqian.eurekacustomer.mapper.UserMapper">
 
+    <sql id="user">
+            id id,
+            name name
+    </sql>
+
+    <select id="findAll" resultType="User">
+        select
+            <include refid="user"/>
+        from user
+    </select>
+
     <select id="findUserById" parameterType="java.lang.String" resultType="User">
-      SELECT * FROM user WHERE id = #{id}
+        select
+            <include refid="user"/>
+        from user
+        <where>
+            id = #{id}
+        </where>
     </select>
 </mapper>