2. 程式人生 > 程式設計 >淺談一個基礎的SpringBoot專案該包含哪些

淺談一個基礎的SpringBoot專案該包含哪些

阿新 • • 發佈：2020-10-28

前言

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

基礎專案該包含哪些東西。

  • 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,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,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

到此這篇關於淺談一個基礎的SpringBoot專案該包含哪些的文章就介紹到這了,更多相關SpringBoot專案包含內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！

相關推薦

淺談一個基礎的SpringBoot專案該包含哪些

前言   建立一個全新的專案，或者把舊的龐大的專案，進行拆分成多個專案。在建立新的專案中，經常需要做一些重複的工作，比如說拷貝一下常用的工具類，通用程式碼等等。所以就可以做一個基礎的專案方便使

淺談HBase在SpringBoot專案裡的應用(含HBaseUtil工具類)

背景： 專案這兩個月開始使用HBase來讀寫資料，網上現成的HBase工具類要麼版本混雜，要麼只是Demo級別的簡單實現，各方面都不完善；

淺談在vue-cli3專案中解決動態引入圖片img404的問題

博主最近手頭再做一個專案，需要呼叫天氣介面，並且還要動態顯示天氣相關圖片icon。

Java 基礎: 淺談型別基礎 - Class 物件

技術標籤：javajavajvmclass反射 Java 基礎: 淺談型別基礎 - Class 物件 文章目錄 Java 基礎: 淺談型別基礎 - Class 物件簡介參考

淺談資料庫遷移類專案功能測試的基本思路

資料庫遷移指的是把歷史資料從A資料庫遷到B資料庫，可劃分為同類型資料庫的遷移和不同型別資料庫之間進行的資料遷移。同類型資料庫的遷移較為簡單，而不同型別資料庫之間的資料遷移就會存在一些問題：如表結構會變化

淺談springboot專案中定時任務如何優雅退出

在一個springboot專案中需要跑定時任務處理批資料時，突然有個Kill命令或者一個Ctrl+C的命令，此時我們需要當批資料處理完畢後才允許定時任務關閉，也就是當定時任務結束時才允許Kill命令生效。

淺談SpringBoot專案打成war和jar的區別

首先給大家來講一個我們遇到的一個奇怪的問題: 1.我的一個springboot專案，用mvn install打包成jar，換一臺有jdk的機器就直接可以用java -jar 專案名.jar的方式執行，沒任何問題，為什麼這裡不需要tomcat也可以運行了

淺談為什麼同一個java檔案只能有一個public類

最近在一個java檔案中實現了幾個類，其中一個宣告為public型別，但編譯器報錯；後來將public去掉，也即檔案中沒有一個public類，程式正常執行，有些困惑，最後通過本文章找到答案，為以後方便查詢

淺談Java併發程式設計基礎知識

程序和執行緒 在並行程式中程序和執行緒是兩個基本的執行單元，在Java併發程式設計中，併發主要核心在於執行緒

淺談go中defer的一個隱藏功能

在開始使用Go進行編碼時，Defer是要關注的一個很重要的特性。它非常簡單：在任何函式中，給其他函式的呼叫加上字首 defer以確保該函式在外部函式退出之前立即執行，即使外部函數出現異常被中斷，該延遲函式也將執行。

淺談Visual Studio 2019 Vue專案的目錄結構

Visual Studio 2019 Vue專案 建立成功後可看到如下結構 Visual Studio 2019配置vue專案 具體檔案結構如下圖

淺談Pycharm的專案檔名是紅色的原因及解決方式

今天在繼續學習Python時，開啟Pycharm後，發現有一個專案下的專案檔名是紅色的，如下圖：

淺談vue的第一個commit分析

為什麼寫這篇vue的分析文章？ 對於天資愚鈍的前端（我）來說，閱讀原始碼是件不容易的事情，畢竟有時候看原始碼分析的文章都看不懂。每次看到大佬們用了1～2年的vue就能掌握原理，甚至精通原始碼，再看看自己用了好

淺談網路請求基礎（理論篇）

網路請求基礎 目錄網路請求基礎1.網路請求過程URL介紹1.1網路請求過程2.請求涉及的基礎2.1請求2.2 請求方法2.4請求體3.響應涉及的基礎3.1 響應介紹：3.2 響應狀態碼3.3 響應頭介紹：3.4 響應體介紹4.網頁基礎4.1網頁

淺談web伺服器專案中request請求和response的相關響應處理

我們經常使用別人的伺服器進行構建網站，現在我們就自己來寫一個自己的服務來使用。

淺談web伺服器專案中靜態請求和動態請求處理

注：完整專案下載 在處理了核心任務之後，我們會發現有些請求並不是都是靜態的，那麼我們就需要進行實現處理動態請求的要求，如下面程式碼是我們請求的解決方式，我們只需在HttpRequestImpl實現類中，將如下程式碼實

python程式設計從零基礎到專案實踐第六章學習---函式 一個完整的求因數函式的完善步驟

1、函式的概念 之前程式碼是過程語言，多少個數的和，都是按著邏輯順利一行一行的寫，為了方便，就把程式碼組織成一個獨立的功能單位，供其他程式碼反覆呼叫。

淺談Vuex的this.$store.commit和在Vue專案中引用公共方法

1、在Vue專案中引用公共方法 作為一個新人小白，在使用vue的過程中，難免會遇到很多的問題，比如某個方法在很多元件中都能用的上，如果在每個元件上都去引用一次的話，會比較麻煩，增加程式碼量。怎麼做比較好呢，話

SpringBoot學習，建立一個簡單的SpringBoot專案，修改Tomcat預設埠和訪問路徑

建立一個簡單的SpringBoot專案 1. 使用IDEA新建一個Maven專案 2.在pom.xml新增SpringBoot的相關依賴

淺談Mybatis持久化框架在Spring、SSM、SpringBoot整合的演進及簡化過程

前言 最近開始了SpringBoot相關知識的學習，作為為目前比較流行、用的比較廣的Spring框架，是每一個Java學習者及從業者都會接觸到一個知識點。作為Spring框架專案，肯定少不了與資料庫持久層的整合。我們在學習Java初