SpringBoot2.x【二】快速開發插件與API規範

時間  2019-11-09
標籤 springboot2.x springboot 快速 開發 插件 api 規範 欄目 Spring 简体版
原文   原文鏈接

萌新：小哥，我在實體類寫了那麼多get/set方法，看着很迷茫
小哥：那不是能夠自動生成嗎？
萌新：雖然能夠自動生成，可是若是我要修改某個變量的數據類型，我豈不是還要去修改get/set方法？
小哥：哈哈，那我今天給你說一個插件，lombok能夠解決你的問題html

1.Lombok插件

對於開發人員來講，我要解釋這個什麼意思，你確定也是隻知其一;不知其二，直接來代碼解釋吧java

代碼演示

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以後mysql

package com.example.entity;

import lombok.Data;

@Data
public class Area {
    private Integer id;

    private Integer postalcode;

    private String address;

    private Integer type;

}
複製代碼

以上二者的效果是相同的,如今咱們知道它是幹嗎的了,下面開始使用吧git

安裝Lombok

在Intellij IDEA中安裝lombok插件github

安裝完重啓IDEAweb

打開設置找到上述並勾選，而後在build.gradle文件中增長spring

//讓gradle具備內置的compileOnly範圍，可用於告訴gradle僅在編譯期間添加lombok
compileOnly 'org.projectlombok:lombok:1.18.4'
複製代碼

刷新Gradle以後就能夠了sql

而後隨意找個測試類，例如以下chrome

package com.example.demo;

import com.example.entity.Area;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {

	@Test
	public void contextLoads() {
        Area area=new Area();
        //這裏能夠有get方法證實就ok 可使用了
        area.getType();
	}

}
複製代碼

2.PageHelper分頁插件

萌新：小哥，我很苦惱分頁這個功能怎麼辦？
小哥：那不是能夠寫好一個邏輯直接複製嗎？
萌新：那也須要不少行代碼，致使了須要在mapper以及業務層作不少無用功
小哥：哈哈，那我來告訴你一款分頁插件，解決你的困擾json

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

/** buildscript中的聲明是gradle腳本自身須要使用的資源。 * 能夠聲明的資源包括依賴項、第三方插件、maven倉庫地址等 */
buildscript {
	ext {
		springBootVersion = '2.0.1.RELEASE'
		mysqlVersion = '5.1.39'
	}
	repositories {
        //使用國內源下載依賴
        maven { url 'http://maven.aliyun.com/nexus/content/groups/public/' }
	}
	dependencies {
		classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
	}
}
// 應用Java插件
apply plugin: 'java'
//讓工程支持IDEA的導入
apply plugin: 'idea'
apply plugin: 'org.springframework.boot'

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
//build.gradle文件中直接聲明的依賴項、倉庫地址等信息是項目自身須要的資源。
repositories {
    maven { url 'http://maven.aliyun.com/nexus/content/groups/public/' }
    mavenCentral()
}

/** * 在gradle裏，對依賴的定義有6種 * compile, runtime, testCompile, testRuntime, providedCompile,providedRuntime * compile:須要引用這個庫才能進行編譯工做 * testRuntime : 測試依賴範圍 * 其餘的瞭解：http://shmilyaw-hotmail-com.iteye.com/blog/2345439 */
dependencies {
	compile('org.springframework.boot:spring-boot-starter-web:2.0.1.RELEASE')
	compile('com.alibaba:druid:1.0.29')
	testCompile('org.springframework.boot:spring-boot-starter-test:2.0.1.RELEASE')
    //這裏的版本能夠在上述定義
	compile 'mysql:mysql-connector-java:5.1.39'
    compile 'org.mybatis.spring.boot:mybatis-spring-boot-starter:1.3.2'
    //讓gradle具備內置的compileOnly範圍，可用於告訴gradle僅在編譯期間添加lombok
	compileOnly 'org.projectlombok:lombok:1.18.4'
    //分頁插件
    compile 'com.github.pagehelper:pagehelper-spring-boot-starter:1.2.10'
}
複製代碼

這裏同時也將SpringBoot升到了2.0，具體的新功能研究後會總結一下的
pagehelper這個插件估計和Spring1.5.x的版本有兼容性問題
上面的配置都是我測試好的，直接替換而後從新刷新Gradle
上篇的自動生成的mapper.xml文件中無查詢所有的方法，這裏補上一下

<select id="selectAreaAll" resultMap="BaseResultMap">
        select
        <include refid="Base_Column_List" />
        from area
    </select>
複製代碼

而後在dao藉口插入方法接口 AreaMapper.java

package com.example.dao;

import com.example.entity.Area;

import java.util.List;

public interface AreaMapper {
    int deleteByPrimaryKey(Integer id);

    int insert(Area record);

    int insertSelective(Area record);

    Area selectByPrimaryKey(Integer id);

    int updateByPrimaryKeySelective(Area record);

    int updateByPrimaryKey(Area record);

    /** * 查詢所有 * @return */
    List<Area> selectAreaAll();
}
複製代碼

** AreaService.java **

package com.example.service;

import com.example.entity.Area;

import java.util.List;

/** * 這裏給dao層的代碼拷貝過來先使用 * created by cfa 2018-11-08 下午 9:56 **/
public interface AreaService {


    int deleteByPrimaryKey(Integer id);

    int insert(Area record);

    int insertSelective(Area record);

    Area selectByPrimaryKey(Integer id);

    int updateByPrimaryKeySelective(Area record);

    int updateByPrimaryKey(Area record);

    List<Area> selectAreaAll(Integer pageNum,Integer pageSize);

}
複製代碼

接口的實現類 AreaServiceImpl.java

/** * 分頁核心代碼 * @param pageNum * @param pageSize * @return */
    @Override
    public List<Area> selectAreaAll(Integer pageNum,Integer pageSize) {
        //這個要在你的查詢以前加哦
        PageHelper.startPage(pageNum,pageSize);
        //這裏直接查詢所有就好了，分頁插件會替你作分頁，也無需擔憂性能問題，會自動補上limit的
        List<Area> areaList=areaMapper.selectAreaAll();
        return areaList;
    }
複製代碼

控制層 AreaController.java

package com.example.controller;


import com.example.entity.Area;
import com.example.service.AreaService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
@RequestMapping("area")
public class AreaController {

    private final AreaService areaService;

    @Autowired
    public AreaController(AreaService areaService) {
        this.areaService = areaService;
    }

    /** * 這裏的@RequestParam(name = "pagesize",required = false,defaultValue = "10") * -name 爲傳輸時爲接受key爲pagesize的參數 * -required 爲是否爲必須傳輸的參數 * -default 就是若是沒有接收到值 就給予默認值 * @param pageNum * @param pageSize * @return */
    @RequestMapping("query")
    public List<Area> areaList(@RequestParam(name = "pagenum",required = false,defaultValue = "1") Integer pageNum, @RequestParam(name = "pagesize",required = false,defaultValue = "10") Integer pageSize){
        return areaService.selectAreaAll(pageNum,pageSize);
    }
}
複製代碼

而後在IDEA中啓動 ** DemoApplication.java** 用postman進行測試

postman下載地址：www.cnblogs.com/wangfeng520…
postman是一款能夠用測試你接口的軟件，推薦花個半個小時來熟悉下


到這裏已經能夠了 若是你的有問題，在我github有代碼，或者百度下錯誤，由於每一個人電腦的java版本不一樣，環境不一樣

3.API接口返回統一化

如今的不少項目都是先後端分離的項目，因此後臺人員返回的參數良莠不齊，每次對接都須要去交流一下，形成開發效率很低，例如，一個操做更新成功，後臺甲可能就返回給前臺一個1，而乙返回一個Map格式，假如批量更新呢，返回的有時候不止是1了，因此接口返回統一化很重要。

萌新：那小哥，我又不是負責人，怎麼統一呢
小哥：最少你本身用了以後返回的API的格式是固定的，前臺很好拿數據
萌新：好的，好的開發規範，人人有責
小哥：和你說下阿里Java開發規範文檔能夠看下，文檔地址：files.cnblogs.com/files/han-1…
萌新：收到！

PageResultBean.java

package com.example.beans;

import com.github.pagehelper.PageInfo;
import lombok.Getter;

import java.io.Serializable;

/* * description : 分頁API統一返回的bean * @return * @time 2018-10-15 下午 9:29 根據曉風輕的ResultBean修改來的 **/
@Getter
public class PageResultBean<T> extends ResultBean<T> implements Serializable {

    // 總記錄數
    private long totalRecord;

    //總頁數
    private int pageCount;

    //當前頁碼
    private int pageNo;

    //當前頁的記錄數量
    private int pageSize;

    public PageResultBean(PageInfo<T> pageInfo) {
        super.setData((T) pageInfo.getList());
        this.setPageNo(pageInfo.getPageNum())
                .setPageSize(pageInfo.getPageSize())
                .setPageCount(pageInfo.getPages())
                .setTotalRecord(pageInfo.getTotal());
    }

    public PageResultBean setTotalRecord(long totalRecord) {
        this.totalRecord = totalRecord;
        return this;
    }

    public PageResultBean setPageCount(int pageCount) {
        this.pageCount = pageCount;
        return this;
    }

    public PageResultBean setPageNo(int pageNo) {
        this.pageNo = pageNo;
        return this;
    }

    public PageResultBean setPageSize(int pageSize) {
        this.pageSize = pageSize;
        return this;
    }

    @Override
    public String toString() {
        return "PageResultBean{" +
                "totalRecord=" + totalRecord +
                ", pageCount=" + pageCount +
                ", pageNo=" + pageNo +
                ", pageSize=" + pageSize +
                '}';
    }

    @Override
    public PageResultBean setMsg(String msg) {
        super.setMsg(msg);
        return this;
    }

    @Override
    public PageResultBean setCode(int code) {
        super.setCode(code);
        return this;
    }

    @Override
    public PageResultBean setData(T data) {
        super.setData(data);
        return this;
    }

}
複製代碼

附上曉風輕所著的ResultBean(略有修改) ResultBean.java

package com.example.beans;

import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@Data
@NoArgsConstructor
public class ResultBean<T> implements Serializable {

    private static final long serialVersionUID = 1L;

    public static final int NO_LOGIN = -1;

    public static final int SUCCESS = 1;

    public static final int FAIL = 0;

    public static final int NO_PERMISSION = 2;

    public static final int USERNAME_EXIST = -909;

    private String msg = "success";

    public static final String TOURIST = "遊客";

    private int code = SUCCESS;

    private T data;

    public ResultBean(T data) {
        super();
        this.data = data;
    }

    public ResultBean(Throwable e) {
        super();
        this.msg = e.toString();
        this.code = FAIL;
    }

    public ResultBean setMsg(String msg) {
        this.msg = msg;
        return this;
    }

    public ResultBean setCode(int code) {
        this.code = code;
        return this;
    }

    public ResultBean setData(T data) {
        this.data = data;
        return this;
    }
}
複製代碼

上述兩個Bean，基本全部的接口返回均可以使用，接口返回的統一化，也使得控制層的代碼更加簡潔 核心：接口返回bean的統一使AOP能夠很好的管理，寫好切入點，對於後續須要作的日誌管理，以及方法運行時間，和全局異常處理，不能再好了

下面看下剛剛的控制層所修改後的效果

@GetMapping("query")
    public PageResultBean<List<Area>> areaList(@RequestParam(name = "pagenum",required = false,defaultValue = "1") Integer pageNum,
                                   @RequestParam(name = "pagesize",required = false,defaultValue = "10") Integer pageSize){
        return new PageResultBean<List<Area>>(new PageInfo(areaService.selectAreaAll(pageNum,pageSize)));
    }
複製代碼

還能夠優化的就是兩個參數的接受，以及後續可能會有的參數查詢，可使用PageResultBean和須要查詢參數的實體類接收
下面啓動DemoApplication
訪問：http://localhost:8080/area/query?pagenum=1&pagesize=10
返回的JSON數據，包括了總頁數，總條數，當前頁數，每頁條數等，表數據在data裏，很是的實用

下面是data裏的表數據

這裏的顯示JSON插件爲：chrome.google.com/webstore/de… 谷歌瀏覽器裏的，推薦使用，這裏或許須要經過GFW，不過谷歌插件裏好像有個谷歌訪問助手，自行研究吧，哈哈

4. Thanks for reading

獲取最新更新地址
juejin.im/post/5d1496…

歡迎關注微信公衆號

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程