天天看點
傳回

一個基礎的SpringBoot項目該包含哪些

一個基礎的SpringBoot項目該包含哪些

前言

  建立一個全新的項目，或者把舊的龐大的項目，進行拆分成多個項目。在建立新的項目中，經常需要做一些重複的工作，比如說拷貝一下常用的工具類，通用代碼等等。是以就可以做一個基礎的項目友善使用，在經曆新項目的時候，直接在基礎項目上進行簡單配置就可以開發業務代碼了。

基礎項目該包含哪些東西。

  • Swagger線上接口文檔。
  • CodeGenerator 代碼生成器。
  • 統一傳回。
  • 通用的分頁對象。
  • 常用工具類。
  • 全局異常攔截。
  • 錯誤枚舉。
  • 自定義異常。
  • 多環境配置檔案。
  • Maven多環境配置。
  • 日志配置。
  • JenkinsFile。
可以在評論區進行補充

Swagger

  寫接口文檔通常是一件比較頭疼的事情，然而swagger就用是用來幫我們解決這個問題的。可以線上生成接口文檔，并且可以在頁面上進行測試。

一個基礎的SpringBoot項目該包含哪些

  可以非常清楚的顯示，請求資料已經響應資料。當然這一切都需要在代碼中進行配置。

一個基礎的SpringBoot項目該包含哪些

注意的點：接口文檔隻能在測試/開發環境開啟，其他環境請關閉。

常用的Swagger注解

  • @Api用于Controller

  • @ApiOperation用于Controller内的方法。

  • @ApiResponses用于辨別接口傳回資料的類型。

  • @ApiModel用于辨別類的名稱

  • @ApiModelProperty用于辨別屬性的名稱

案例 

@RestController
@Api(tags = "使用者")
@AllArgsConstructor
@RequestMapping("/user")
public class UserController {

    private IUserService userService;

    /**
     * 擷取使用者清單
     * @param listUserForm 表單資料
     * @return 使用者清單
     */
    @ApiOperation("擷取使用者清單")
    @GetMapping("/listUser")
    @ApiResponses(
            @ApiResponse(code = 200, message = "操作成功", response = UserVo.class)
    )
    public ResultVo listUser(@Validated ListUserForm listUserForm){
        return ResultVoUtil.success(userService.listUser(listUserForm));
    }
    
}           
@Data
@ApiModel("擷取使用者清單需要的表單資料")
@EqualsAndHashCode(callSuper = false)
public class ListUserForm extends PageForm<ListUserForm> {

    /**
     * 使用者狀态
     */
    @ApiModelProperty("使用者狀态")
    @NotEmpty(message = "使用者狀态不能為空")
    @Range(min =  -1 , max = 1 , message = "使用者狀态有誤")
    private String status;

}

對應的swagger的配置可以檢視

基礎項目

内的

SwaggerConfiguration.java

.

CodeGenerator代碼生成器。

   mybatis_plus代碼生成器可以幫我們生成

entity

,

service

serviceImpl

mapper

mapper.xml

。省去了建立一大堆實體類的麻煩。

  由于配置太長這裡就不貼出來了，對應的CodeGenerator的配置可以檢視

CodeGenerator.java

常用的封裝

統一傳回 ResultVo

将所有的接口的響應資料的格式進行統一。

@Data
@ApiModel("固定傳回格式")
public class ResultVo {

    /**
     * 錯誤碼
     */
    @ApiModelProperty("錯誤碼")
    private Integer code;

    /**
     * 提示資訊
     */
    @ApiModelProperty("提示資訊")
    private String message;

    /**
     * 具體的内容
     */
    @ApiModelProperty("響應資料")
    private Object data;

}

抽象表單 BaseForm 

public abstract class BaseForm<T> {

    /**
     * 擷取執行個體
     * @return 傳回實體類
     */
    public abstract T buildEntity();

}

有小夥伴可能有疑問了，這個類有啥用呢。先看一下，下面的代碼。

/**
     * 添加使用者
     * @param userForm 表單資料
     * @return true 或者 false
     */
    @Override
    public boolean addUser(AddUserForm userForm) {
        User user = new User();
        user.setNickname(userForm.getNickname());
        user.setBirthday(userForm.getBirthday());
        user.setUsername(userForm.getUsername());
        user.setPassword(userForm.getPassword());
        return save(user);
    }

重構一下，感覺清爽了一些。

/**
 * 添加使用者
 * @param userForm 表單資料
 * @return true 或者 false
 */
@Override
public boolean addUser(AddUserForm userForm) {
    User user = new User();
    BeanUtils.copyProperties(this,user);
    return save(user);
}

使用BaseForm進行重構 AddUserForm 繼承 BaseForm并重寫buildEntity

@Data
@EqualsAndHashCode(callSuper = false)
public class AddUserForm extends BaseForm<User> {

    /**
     * 昵稱
     */
    private String nickname;

    /**
     * 生日
     */
    private Date birthday;

    /**
     * 使用者名
     */
    private String username;

    /**
     * 密碼
     */
    private String password;

    /**
     * 構造實體
     * @return 實體對象
     */
    @Override
    public User buildEntity() {
        User user = new User();
        BeanUtils.copyProperties(this,user);
        return user;
    }
}           
/**
 * 添加使用者
 * @param userForm 表單資料
 * @return true 或者 false
 */
@Override
public boolean addUser(AddUserForm userForm) {
    return save(userForm.buildEntity());
}

   上面的代碼有沒有種似曾相識的感覺，很多情況都是将接受到的參數，轉變成對應的實體類然後儲存或者更新。是以對于這類的

form

可以繼承

baseform

并實作

buildEntity()

這樣可以更加符合面向對象，

service

不需要關心

form

如何轉變成

entity

,隻需要在使用的時候調用

buildEntity()

即可，尤其是在

form

->

entity

相對複雜的時候，這樣做可以減少

service

内的代碼。讓代碼邏輯看起來更加清晰。

通用的分頁對象

  涉及到查詢的時候，絕大多數都需要用到分頁，是以說封裝分頁對象就很有必要。可以注意下

PageForm.calcCurrent()

、

PageVo.setCurrentAndSize()

PageVo.setTotal()

這個幾個方法。

PageForm 

@Data
@ApiModel(value = "分頁資料", description = "分頁需要的表單資料")
public class PageForm<T extends PageForm<?>>{

    /**
     * 頁碼
     */
    @ApiModelProperty(value = "頁碼 從第一頁開始 1")
    @Min(value = 1, message = "頁碼輸入有誤")
    private Integer current;

    /**
     * 每頁顯示的數量
     */
    @ApiModelProperty(value = "每頁顯示的數量 範圍在1~100")
    @Range(min = 1, max = 100, message = "每頁顯示的數量輸入有誤")
    private Integer size;

    /**
     * 計算目前頁 ,友善mysql 進行分頁查詢
     * @return 傳回 pageForm
     */
    @ApiModelProperty(hidden = true)
    public T calcCurrent(){
        current = (current - 1 ) * size;
        return (T) this;
    }
}

PageVo 

@Data
public class PageVo<T> {
    /**
     * 分頁資料
     */
    @ApiModelProperty(value = "分頁資料")
    private List<T> records;
    /**
     * 總條數
     */
    @ApiModelProperty(value = "總條數")
    private Integer total;

    /**
     * 總頁數
     */
    @ApiModelProperty(value = "總頁數")
    private Integer pages;

    /**
     * 目前頁
     */
    @ApiModelProperty(value = "目前頁")
    private Integer current;

    /**
     * 查詢數量
     */
    @ApiModelProperty(value = "查詢數量")
    private Integer size;

    /**
     * 設定目前頁和每頁顯示的數量
     * @param pageForm 分頁表單
     * @return 傳回分頁資訊
     */
    @ApiModelProperty(hidden = true)
    public PageVo<T> setCurrentAndSize(PageForm<?> pageForm){
        BeanUtils.copyProperties(pageForm,this);
        return this;
    }

    /**
     * 設定總記錄數
     * @param total 總記錄數
     */
    @ApiModelProperty(hidden = true)
    public void setTotal(Integer total) {
        this.total = total;
        this.setPages(this.total % this.size > 0 ? this.total / this.size + 1 : this.total / this.size);
    }
}

ListUserForm 
@Data
@ApiModel("擷取使用者清單需要的表單資料")
@EqualsAndHashCode(callSuper = false)
public class ListUserForm extends PageForm<ListUserForm> {

    /**
     * 使用者狀态
     */
    @ApiModelProperty("使用者狀态")
    @NotEmpty(message = "使用者狀态不能為空")
    @Range(min =  -1 , max = 1 , message = "使用者狀态有誤")
    private String status;

}
UserServiceImpl 
/**
 * 擷取使用者清單
 * @param listUserForm 表單資料
 * @return 使用者清單
 */
@Override
public PageVo<UserVo> listUser(ListUserForm listUserForm) {
    PageVo<UserVo> pageVo = new PageVo<UserVo>().setCurrentAndSize(listUserForm);
    pageVo.setTotal(countUser(listUserForm.getStatus()));
    pageVo.setRecords(userMapper.listUser(listUserForm.calcCurrent()));
    return pageVo;
}

/**
 * 擷取使用者數量
 * @param status 狀态
 * @return 使用者數量
 */
private Integer countUser(String status){
    return count(new QueryWrapper<User>().eq("status",status));
}
UserController 
/**
 * 擷取使用者清單
 * @param listUserForm 表單資料
 * @return 使用者清單
 */
@ApiOperation("擷取使用者清單")
@GetMapping("/listUser")
@ApiResponses(
        @ApiResponse(code = 200, message = "操作成功", response = UserVo.class)
)
public ResultVo listUser(@Validated ListUserForm listUserForm){
    return ResultVoUtil.success(userService.listUser(listUserForm));
}
一個基礎的SpringBoot項目該包含哪些
注意的點
  • PageVo在執行個體化的時候需要設定目前頁和每頁顯示的數量 可以調用

    setCurrentAndSize()

     完成。
  • 進行分頁查詢的時候，需要計算偏移量。

    listUserForm.calcCurrent()

為什麼要計算偏移量呢？

  • 假如查詢第1頁每頁顯示10條記錄，前端傳遞過來的參數是

    current=1&&size=10

     ，這個時候

    limit 1,10

     沒有問題。
  • 假如查詢第2頁每頁顯示10條記錄，前端傳遞過來的參數是

    current=2&&size=10

    limit 2,10

     就有問題，實際應該是

    limit 10,10

     。

    calcCurrent()的作用就是如此

為什麼不用MybatisPlus自帶的分頁插件呢？

自帶的分頁查詢在大量資料下，會出現性能問題。

常用工具類

常用工具類可以根據自己的開發習慣引入。

異常處理

異常處理的大緻流程主要如下。

  • 異常資訊抛出 ->

    ControllerAdvice

     進行捕獲格式化輸出内容
  • 手動抛出

    CustomException

     并傳入

    ReulstEnum

     ——> 進行捕獲錯誤資訊輸出錯誤資訊。

自定義異常 

@Data
@EqualsAndHashCode(callSuper = false)
public class CustomException extends RuntimeException {

    /**
     * 狀态碼
     */
    private final Integer code;

    /**
     * 方法名稱
     */
    private final String method;


    /**
     * 自定義異常
     *
     * @param resultEnum 傳回枚舉對象
     * @param method     方法
     */
    public CustomException(ResultEnum resultEnum, String method) {
        super(resultEnum.getMsg());
        this.code = resultEnum.getCode();
        this.method = method;
    }

    /**
     * @param code    狀态碼
     * @param message 錯誤資訊
     * @param method  方法
     */
    public CustomException(Integer code, String message, String method) {
        super(message);
        this.code = code;
        this.method = method;
    }

}

錯誤資訊枚舉

根據業務進行添加。

@Getter
public enum ResultEnum {

    /**
     * 未知異常
     */
    UNKNOWN_EXCEPTION(100, "未知異常"),

    /**
     * 添加失敗
     */
    ADD_ERROR(103, "添加失敗"),

    /**
     * 更新失敗
     */
    UPDATE_ERROR(104, "更新失敗"),

    /**
     * 删除失敗
     */
    DELETE_ERROR(105, "删除失敗"),

    /**
     * 查找失敗
     */
    GET_ERROR(106, "查找失敗"),

    ;
    
    private Integer code;

    private String msg;

    ResultEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    /**
     * 通過狀态碼擷取枚舉對象
     * @param code 狀态碼
     * @return 枚舉對象
     */
    public static ResultEnum getByCode(int code){
        for (ResultEnum resultEnum : ResultEnum.values()) {
            if(code == resultEnum.getCode()){
                return resultEnum;
            }
        }
        return null;
    }
    
}

全局異常攔截

全局異常攔截是使用

@ControllerAdvice

進行實作，常用的異常攔截配置可以檢視

GlobalExceptionHandling 
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandling {

    /**
     * 自定義異常
     */
    @ExceptionHandler(value = CustomException.class)
    public ResultVo processException(CustomException e) {
        log.error("位置:{} -> 錯誤資訊:{}", e.getMethod() ,e.getLocalizedMessage());
        return ResultVoUtil.error(Objects.requireNonNull(ResultEnum.getByCode(e.getCode())));
    }

    /**
     * 通用異常
     */
    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(Exception.class)
    public ResultVo exception(Exception e) {
        e.printStackTrace();
        return ResultVoUtil.error(ResultEnum.UNKNOWN_EXCEPTION);
    }
}

Controller 
/**
 * 删除使用者
 * @param id 使用者編号
 * @return 成功或者失敗
 */
@ApiOperation("删除使用者")
@DeleteMapping("/deleteUser/{id}")
public ResultVo deleteUser(@PathVariable("id") String id){
    userService.deleteUser(id);
    return ResultVoUtil.success();
}
Service 
/**
 * 删除使用者
 * @param id id
 */
@Override
public void deleteUser(String id) {
    // 如果删除失敗抛出異常。 -- 示範而已不推薦這樣幹
    if(!removeById(id)){
        throw new CustomException(ResultEnum.DELETE_ERROR, MethodUtil.getLineInfo());
    }
}
結果
一個基礎的SpringBoot項目該包含哪些
一個基礎的SpringBoot項目該包含哪些

将報錯代碼所在的檔案第多少行都列印出來。友善排查。

  所有手動抛出的錯誤資訊，都應在錯誤資訊枚舉

ResultEnum

進行統一維護。不同的業務使用不同的錯誤碼。友善在報錯時進行分辨。快速定位問題。

多環境配置

SpringBoot多環境配置

  對于一個項目來講基本都4有個環境

dev

test

pre

prod

，對于SpringBoot項目多建立幾個配置檔案就可以了。然後啟動的時候可以通過配置

spring.profiles.active

來選擇啟動的環境。

一個基礎的SpringBoot項目該包含哪些
java -jar BasicProject.jar --spring.profiles.active=prod

Maven多環境配置

  假如想在打包的時候動态指定環境，這個時候就需要借助Maven的xml來實作。

配置XML 
<!--  配置環境  -->
<profiles>
    <profile>
        <!-- 開發 -->
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <activatedProperties>dev</activatedProperties>
        </properties>
    </profile>
    <profile>
        <!-- 測試 -->
        <id>test</id>
        <properties>
            <activatedProperties>test</activatedProperties>
        </properties>
    </profile>
    <profile>
        <!-- 準生産 -->
        <id>pre</id>
        <properties>
            <activatedProperties>pre</activatedProperties>
        </properties>
    </profile>
    <profile>
        <!-- 生産 -->
        <id>prod</id>
        <properties>
            <activatedProperties>prod</activatedProperties>
        </properties>
    </profile>
</profiles>
更改application.yml 
spring:
  profiles:
    # 選擇環境
    active: @activatedProperties@
使用案例 
mvn clean package -P prod
mvn clean package -P pre
mvn clean package -P test

  打包完可以解壓開檢視

application.yml

會發現

spring.profiles.active=@activatedProperties@

發生了改變。

日志配置

采用logback

JenkinsFile

  JenkinsFile肯定顧名思義是給jenkins用的。主要是配置項目根據如何進行建構并釋出到不同的環境。需要去了解pipeline文法，以及如何配置jenkins。

JenkinsFileDemo

代碼位址

https://gitee.com/huangxunhui/basic_project.git

結尾

  如果覺得對你有幫助，可以多多評論，多多點贊哦，也可以到我的首頁看看，說不定有你喜歡的文章，也可以随手點個關注哦，謝謝。

  我是不一樣的科技宅，每天進步一點點，體驗不一樣的生活。我們下期見！

xml 前端開發 java jenkins 持續傳遞 api Maven 資料安全/隐私保護 資料格式 spring spring基礎教程poll spring基礎教程poll規則 java遺傳算法程式設計搜尋 spring項目tomcat spring mybatis項目整合
上一篇: MongoDB大量集合啟動加載優化原理
下一篇: Windows容器使用阿裡雲NAS SMB檔案系統做持久化存儲目錄手工挂載步驟開機自啟動步驟

繼續閱讀