Spring全家桶系列--SpringBoot渐入佳境

1.Lombok插件

对于开发人员来说，我要解释这个什么意思，你肯定也是一知半解，直接来代码解释吧

1.1 代码演示

package
 com
.
example
.
entity
;
public
class
Area
{
private
Integer
 id
;
private
Integer
 postalcode
;
private
String
 address
;
private
Integer
 type
;
public
Integer
 getId
()
{
return
 id
;
}
public
void
 setId
(
Integer
 id
)
{
this
.
id 
=
 id
;
}
public
Integer
 getPostalcode
()
{
return
 postalcode
;
}
public
void
 setPostalcode
(
Integer
 postalcode
)
{
this
.
postalcode 
=
 postalcode
;
}
public
String
 getAddress
()
{
return
 address
;
}
public
void
 setAddress
(
String
 address
)
{
this
.
address 
=
 address 
==
null
?
null
:
 address
.
trim
();
}
public
Integer
 getType
()
{
return
 type
;
}
public
void
 setType
(
Integer
 type
)
{
this
.
type 
=
 type
;
}
}

使用了Lombok之后

package
 com
.
example
.
entity
;
import
 lombok
.
Data
;
@Data
public
class
Area
{
private
Integer
 id
;
private
Integer
 postalcode
;
private
String
 address
;
private
Integer
 type
;
}

以上两者的效果是相同的,现在我们知道它是干嘛的了,下面开始使用吧

1.2 安装Lombok

在Intellij IDEA中安装lombok插件

打开设置找到上述并勾选，然后在build.gradle文件中增加

1. //让gradle具有内置的compileOnly范围，可用于告诉gradle仅在编译期间添加lombok
   
2. compileOnly 'org.projectlombok:lombok:1.18.4'
   

刷新Gradle之后就可以了

然后随意找个测试类，例如如下

1. package com.example.demo;
   
2. 
   
3. import com.example.entity.Area;
   
4. import org.junit.Test;
   
5. import org.junit.runner.RunWith;
   
6. import org.springframework.boot.test.context.SpringBootTest;
   
7. import org.springframework.test.context.junit4.SpringRunner;
   
8. 
   
9. @RunWith(SpringRunner.class)
   
10. @SpringBootTest
    
11. publicclassDemoApplicationTests{
    
12. 
    
13.    @Test
    
14.    publicvoid contextLoads(){
    
15.        Area area=newArea();
    
16.        //这里可以有get方法证明就ok 可以使用了
    
17.        area.getType();
    
18.    }
    
19. 
    
20. }
    

2.PageHelper分页插件

萌新：小哥，我很苦恼分页这个功能怎么办？

小哥：那不是可以写好一个逻辑直接复制吗？

萌新：那也需要很多行代码，导致了需要在mapper以及业务层做很多无用功

小哥：哈哈，那我来告诉你一款分页插件，解决你的困扰

首先，在build.gradle中引入依赖

1. /** buildscript中的声明是gradle脚本自身需要使用的资源。
   
2. *  可以声明的资源包括依赖项、第三方插件、maven仓库地址等
   
3. */
   
4. buildscript {
   
5.    ext {
   
6.        springBootVersion ='2.0.1.RELEASE'
   
7.        mysqlVersion ='5.1.39'
   
8.    }
   
9.    repositories {
   
10.        //使用国内源下载依赖
    
11.        maven { url 'http://maven.aliyun.com/nexus/content/groups/public/'}
    
12.    }
    
13.    dependencies {
    
14.        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    
15.    }
    
16. }
    
17. // 应用Java插件
    
18. apply plugin:'java'
    
19. //让工程支持IDEA的导入
    
20. apply plugin:'idea'
    
21. apply plugin:'org.springframework.boot'
    
22. 
    
23. group='com.example'
    
24. version ='0.0.1-SNAPSHOT'
    
25. sourceCompatibility =1.8
    
26. //build.gradle文件中直接声明的依赖项、仓库地址等信息是项目自身需要的资源。
    
27. repositories {
    
28.    maven { url 'http://maven.aliyun.com/nexus/content/groups/public/'}
    
29.    mavenCentral()
    
30. }
    
31. 
    
32. /**
    
33. * 在gradle里，对依赖的定义有6种
    
34. * compile, runtime, testCompile, testRuntime, providedCompile,providedRuntime
    
35. * compile:需要引用这个库才能进行编译工作
    
36. * testRuntime : 测试依赖范围
    
37. * 其他的了解：http://shmilyaw-hotmail-com.iteye.com/blog/2345439
    
38. */
    
39. dependencies {
    
40.    compile('org.springframework.boot:spring-boot-starter-web:2.0.1.RELEASE')
    
41.    compile('com.alibaba:druid:1.0.29')
    
42.    testCompile('org.springframework.boot:spring-boot-starter-test:2.0.1.RELEASE')
    
43.    //这里的版本可以在上述定义
    
44.    compile 'mysql:mysql-connector-java:5.1.39'
    
45.    compile 'org.mybatis.spring.boot:mybatis-spring-boot-starter:1.3.2'
    
46.    //让gradle具有内置的compileOnly范围，可用于告诉gradle仅在编译期间添加lombok
    
47.    compileOnly 'org.projectlombok:lombok:1.18.4'
    
48.    //分页插件
    
49.    compile 'com.github.pagehelper:pagehelper-spring-boot-starter:1.2.10'
    
50. }
    

这里同时也将SpringBoot升到了2.0，具体的新功能研究后会总结一下的

pagehelper这个插件估计和Spring1.5.x的版本有兼容性问题

上面的配置都是我测试好的，直接替换然后重新刷新Gradle

上篇的自动生成的mapper.xml文件中无查询全部的方法，这里补上一下

1.    <selectid="selectAreaAll"resultMap="BaseResultMap">
   
2.        select
   
3.        <includerefid="Base_Column_List"/>
   
4.        from area
   
5.    </select>
   

然后在dao借口插入方法接口 AreaMapper.java

1. 
   
2. package com.example.dao;
   
3. 
   
4. import com.example.entity.Area;
   
5. 
   
6. import java.util.List;
   
7. 
   
8. publicinterfaceAreaMapper{
   
9.    int deleteByPrimaryKey(Integer id);
   
10. 
    
11.    int insert(Area record);
    
12. 
    
13.    int insertSelective(Area record);
    
14. 
    
15.    Area selectByPrimaryKey(Integer id);
    
16. 
    
17.    int updateByPrimaryKeySelective(Area record);
    
18. 
    
19.    int updateByPrimaryKey(Area record);
    
20. 
    
21.    /**
    
22.     * 查询全部
    
23.     * @return
    
24.     */
    
25.    List<Area> selectAreaAll();
    
26. }
    

AreaService.java

1. package com.example.service;
   
2. 
   
3. import com.example.entity.Area;
   
4. 
   
5. import java.util.List;
   
6. 
   
7. /**
   
8. * 这里给dao层的代码拷贝过来先使用
   
9. * created by cfa  2018-11-08 下午 9:56
   
10. **/
    
11. publicinterfaceAreaService{
    
12. 
    
13. 
    
14.    int deleteByPrimaryKey(Integer id);
    
15. 
    
16.    int insert(Area record);
    
17. 
    
18.    int insertSelective(Area record);
    
19. 
    
20.    Area selectByPrimaryKey(Integer id);
    
21. 
    
22.    int updateByPrimaryKeySelective(Area record);
    
23. 
    
24.    int updateByPrimaryKey(Area record);
    
25. 
    
26.    List<Area> selectAreaAll(Integer pageNum,Integer pageSize);
    
27. 
    
28. }
    

上述接口的实现类加上 AreaServiceImpl.java

1.    /**
   
2.     *  分页核心代码
   
3.     * @param pageNum
   
4.     * @param pageSize
   
5.     * @return
   
6.     */
   
7.    @Override
   
8.    publicList<Area> selectAreaAll(Integer pageNum,Integer pageSize){
   
9.        //这个要在你的查询之前加哦
   
10.        PageHelper.startPage(pageNum,pageSize);
    
11.        //这里直接查询全部就行了，分页插件会替你做分页，也无需担心性能问题，会自动补上limit的
    
12.        List<Area> areaList=areaMapper.selectAreaAll();
    
13.        return areaList;
    
14.    }
    

控制层调用 AreaController.java

1. package com.example.controller;
   
2. 
   
3. 
   
4. import com.example.entity.Area;
   
5. import com.example.service.AreaService;
   
6. import org.springframework.beans.factory.annotation.Autowired;
   
7. import org.springframework.web.bind.annotation.RequestMapping;
   
8. import org.springframework.web.bind.annotation.RequestParam;
   
9. import org.springframework.web.bind.annotation.RestController;
   
10. 
    
11. import java.util.List;
    
12. 
    
13. @RestController
    
14. @RequestMapping("area")
    
15. publicclassAreaController{
    
16. 
    
17.    privatefinalAreaService areaService;
    
18. 
    
19.    @Autowired
    
20.    publicAreaController(AreaService areaService){
    
21.        this.areaService = areaService;
    
22.    }
    
23. 
    
24.    /**
    
25.     * 这里的@RequestParam(name = "pagesize",required = false,defaultValue = "10")
    
26.     * -name 为传输时为接受key为pagesize的参数
    
27.     * -required 为是否为必须传输的参数
    
28.     * -default 就是如果没有接收到值 就给予默认值
    
29.     * @param pageNum
    
30.     * @param pageSize
    
31.     * @return
    
32.     */
    
33.    @RequestMapping("query")
    
34.    publicList<Area> areaList(@RequestParam(name ="pagenum",required =false,defaultValue ="1")Integer pageNum,
    
35.                               @RequestParam(name ="pagesize",required =false,defaultValue ="10")Integer pageSize){
    
36.        return areaService.selectAreaAll(pageNum,pageSize);
    
37.    }
    
38. }
    

然后在IDEA中启动DemoApplication启动类

用postman进行测试

postman下载地址：

https://www.cnblogs.com/wangfeng520/p/5892125.html

postman是一款可以用测试你接口的软件，推荐花个半个小时来熟悉下

到这里已经可以了

如果你的有问题，在我github有代码，或者百度下错误，因为每个人电脑的java版本不同，环境不同

3.API接口返回统一化

现在的很多项目都是前后端分离的项目，所以后台人员返回的参数参差不齐，每次对接都需要去交流一下，造成开发效率很低。

例如，一个操作更新成功，后台甲可能就返回给前台一个1，而乙返回一个Map格式，假如批量更新呢，返回的有时候不止是1了，所以接口返回统一化很重要。

萌新：那小哥，我又不是负责人，怎么统一呢

小哥：最少你自己用了之后返回的API的格式是固定的，前台很好拿数据

萌新：好的，好的开发规范，人人有责

小哥：和你说下阿里Java开发规范文档可以看下。

文档地址：

https://files.cnblogs.com/files/han-1034683568/%E9%98%BF%E9%87%8C%E5%B7%B4%E5%B7%B4Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C%E7%BB%88%E6%9E%81%E7%89%88v1.3.0.pdf

萌新：收到！

PageResultBean.java

1. package com.example.beans;
   
2. 
   
3. import com.github.pagehelper.PageInfo;
   
4. import lombok.Getter;
   
5. 
   
6. import java.io.Serializable;
   
7. 
   
8. /*
   
9. * description : 分页API统一返回的bean
   
10. * @return
    
11. * @time 2018-10-15 下午 9:29 根据晓风轻的ResultBean修改来的
    
12. **/
    
13. @Getter
    
14. publicclassPageResultBean<T>extendsResultBean<T>implementsSerializable{
    
15. 
    
16.    // 总记录数
    
17.    privatelong totalRecord;
    
18. 
    
19.    //总页数
    
20.    privateint pageCount;
    
21. 
    
22.    //当前页码
    
23.    privateint pageNo;
    
24. 
    
25.    //当前页的记录数量
    
26.    privateint pageSize;
    
27. 
    
28.    publicPageResultBean(PageInfo<T> pageInfo){
    
29.        super.setData((T) pageInfo.getList());
    
30.        this.setPageNo(pageInfo.getPageNum())
    
31.                .setPageSize(pageInfo.getPageSize())
    
32.                .setPageCount(pageInfo.getPages())
    
33.                .setTotalRecord(pageInfo.getTotal());
    
34.    }
    
35. 
    
36.    publicPageResultBean setTotalRecord(long totalRecord){
    
37.        this.totalRecord = totalRecord;
    
38.        returnthis;
    
39.    }
    
40. 
    
41.    publicPageResultBean setPageCount(int pageCount){
    
42.        this.pageCount = pageCount;
    
43.        returnthis;
    
44.    }
    
45. 
    
46.    publicPageResultBean setPageNo(int pageNo){
    
47.        this.pageNo = pageNo;
    
48.        returnthis;
    
49.    }
    
50. 
    
51.    publicPageResultBean setPageSize(int pageSize){
    
52.        this.pageSize = pageSize;
    
53.        returnthis;
    
54.    }
    
55. 
    
56.    @Override
    
57.    publicString toString(){
    
58.        return"PageResultBean{"+
    
59.                "totalRecord="+ totalRecord +
    
60.                ", pageCount="+ pageCount +
    
61.                ", pageNo="+ pageNo +
    
62.                ", pageSize="+ pageSize +
    
63.                '}';
    
64.    }
    
65. 
    
66.    @Override
    
67.    publicPageResultBean setMsg(String msg){
    
68.        super.setMsg(msg);
    
69.        returnthis;
    
70.    }
    
71. 
    
72.    @Override
    
73.    publicPageResultBean setCode(int code){
    
74.        super.setCode(code);
    
75.        returnthis;
    
76.    }
    
77. 
    
78.    @Override
    
79.    publicPageResultBean setData(T data){
    
80.        super.setData(data);
    
81.        returnthis;
    
82.    }
    
83. 
    
84. }
    

附上晓风轻所著的ResultBean(略有修改) ResultBean.java

1. package com.example.beans;
   
2. 
   
3. import lombok.Data;
   
4. import lombok.NoArgsConstructor;
   
5. 
   
6. import java.io.Serializable;
   
7. 
   
8. @Data
   
9. @NoArgsConstructor
   
10. publicclassResultBean<T>implementsSerializable{
    
11. 
    
12.    privatestaticfinallong serialVersionUID =1L;
    
13. 
    
14.    publicstaticfinalint NO_LOGIN =-1;
    
15. 
    
16.    publicstaticfinalint SUCCESS =1;
    
17. 
    
18.    publicstaticfinalint FAIL =0;
    
19. 
    
20.    publicstaticfinalint NO_PERMISSION =2;
    
21. 
    
22.    publicstaticfinalint USERNAME_EXIST =-909;
    
23. 
    
24.    privateString msg ="success";
    
25. 
    
26.    publicstaticfinalString TOURIST ="游客";
    
27. 
    
28.    privateint code = SUCCESS;
    
29. 
    
30.    private T data;
    
31. 
    
32.    publicResultBean(T data){
    
33.        super();
    
34.        this.data = data;
    
35.    }
    
36. 
    
37.    publicResultBean(Throwable e){
    
38.        super();
    
39.        this.msg = e.toString();
    
40.        this.code = FAIL;
    
41.    }
    
42. 
    
43.    publicResultBean setMsg(String msg){
    
44.        this.msg = msg;
    
45.        returnthis;
    
46.    }
    
47. 
    
48.    publicResultBean setCode(int code){
    
49.        this.code = code;
    
50.        returnthis;
    
51.    }
    
52. 
    
53.    publicResultBean setData(T data){
    
54.        this.data = data;
    
55.        returnthis;
    
56.    }
    
57. }
    

上述两个Bean，基本所有的接口返回都可以使用，接口返回的统一化，也使得控制层的代码更加简洁

核心：接口返回bean的统一使AOP可以很好的管理，写好切入点，对于后续需要做的日志管理，以及方法运行时间，和全局异常处理，不能再好了

下面看下刚刚的控制层所修改后的效果

1.    @GetMapping("query")
   
2.    publicPageResultBean<List<Area>> areaList(@RequestParam(name ="pagenum",required =false,defaultValue ="1")Integer pageNum,
   
3.                                   @RequestParam(name ="pagesize",required =false,defaultValue ="10")Integer pageSize){
   
4.        returnnewPageResultBean<List<Area>>(newPageInfo(areaService.selectAreaAll(pageNum,pageSize)));
   
5.    }
   

还可以优化的就是两个参数的接受，以及后续可能会有的参数查询，可以使用PageResultBean和需要查询参数的实体类接收

下面启动DemoApplication

访问：http://localhost:8080/area/query?pagenum=1&pagesize=10

返回的JSON数据，包括了总页数，总条数，当前页数，每页条数等，表数据在data里，非常的实用

下面是data里的表数据

这里的显示JSON插件为：

https://chrome.google.com/webstore/detail/json-viewer/gbmdgpbipfallnflgajpaliibnhdgobh

谷歌浏览器里的，推荐使用。

代码的github地址：

https://github.com/cuifuan/springboot-demo