成人免费xxxxx在线视频软件_久久精品久久久_亚洲国产精品久久久_天天色天天色_亚洲人成一区_欧美一级欧美三级在线观看

一個Spring Boot項目該包含哪些？

作者：佚名
開發 后端
建立一個全新的項目，或者把舊的龐大的項目，進行拆分成多個項目。在建立新的項目中，經常需要做一些重復的工作，比如說拷貝一下常用的工具類，通用代碼等等。

前言

建立一個全新的項目，或者把舊的龐大的項目，進行拆分成多個項目。在建立新的項目中，經常需要做一些重復的工作，比如說拷貝一下常用的工具類，通用代碼等等。

所以就可以做一個基礎的項目方便使用，在經歷新項目的時候，直接在基礎項目上進行簡單配置就可以開發業務代碼了。

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

  •  Swagger在線接口文檔。
  •  CodeGenerator 代碼生成器。
  •  統一返回。
  •  通用的分頁對象。
  •  常用工具類。
  •  全局異常攔截。
  •  錯誤枚舉。
  •  自定義異常。
  •  多環境配置文件。
  •  Maven多環境配置。
  •  日志配置。
  •  JenkinsFile。   

Swagger

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

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

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

常用的Swagger注解

  •  @Api用于Controller
  •  @ApiOperation用于Controller內的方法。
  •  @ApiResponses用于標識接口返回數據的類型。
  •  @ApiModel用于標識類的名稱
  •  @ApiModelProperty用于標識屬性的名稱

案例 

  1. @RestController    
  2. @Api(tags = "用戶")    
  3. @AllArgsConstructor    
  4. @RequestMapping("/user")    
  5. public class UserController {    
  6.     private IUserService userService;    
  7.     /**    
  8.      * 獲取用戶列表    
  9.      * @param listUserForm 表單數據    
  10.      * @return 用戶列表    
  11.      */    
  12.     @ApiOperation("獲取用戶列表")    
  13.     @GetMapping("/listUser")    
  14.     @ApiResponses(    
  15.             @ApiResponse(code = 200, message = "操作成功", response = UserVo.class)    
  16.     )    
  17.     public ResultVo listUser(@Validated ListUserForm listUserForm){    
  18.         return ResultVoUtil.success(userService.listUser(listUserForm));    
  19.     }   
  20. }    
  1. @Data    
  2. @ApiModel("獲取用戶列表需要的表單數據")    
  3. @EqualsAndHashCode(callSuper = false)    
  4. public class ListUserForm extends PageForm<ListUserForm> {     
  5.     /**    
  6.      * 用戶狀態    
  7.      */    
  8.     @ApiModelProperty("用戶狀態")    
  9.     @NotEmpty(message = "用戶狀態不能為空")    
  10.     @Range(min =  -1 , max = 1 , message = "用戶狀態有誤")    
  11.     private String status;    
  12. }   

對應的swagger的配置可以查看基礎項目內的SwaggerConfiguration.java.點擊這里參考詳細教程。關注公眾號Java技術棧回復boot可以獲取Spring Boot系列教程。

CodeGenerator代碼生成器。

mybatis_plus代碼生成器可以幫我們生成entity,service,serviceImpl,mapper,mapper.xml。省去了建立一大堆實體類的麻煩。沒聽過的可以點擊這里參考這篇文章。

由于配置太長這里就不貼出來了，對應的CodeGenerator的配置可以查看基礎項目內的CodeGenerator.java.

常用的封裝

統一返回 ResultVo

將所有的接口的響應數據的格式進行統一。 

  1. @Data    
  2. @ApiModel("固定返回格式")   
  3. public class ResultVo {    
  4.     /**    
  5.      * 錯誤碼    
  6.      */    
  7.     @ApiModelProperty("錯誤碼")    
  8.     private Integer code;    
  9.     /**    
  10.      * 提示信息    
  11.      */    
  12.     @ApiModelProperty("提示信息")    
  13.     private String message;    
  14.     /**    
  15.      * 具體的內容    
  16.      */    
  17.     @ApiModelProperty("響應數據")   
  18.     private Object data;    
  19. }   

抽象表單 BaseForm 

  1. public abstract class BaseForm<T> {      
  2.     /**    
  3.      * 獲取實例    
  4.      * @return 返回實體類    
  5.      */    
  6.     public abstract T buildEntity();    
  7. }   

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

  1. /**    
  2.  * 添加用戶    
  3.  * @param userForm 表單數據    
  4.  * @return true 或者 false    
  5.  */   
  6.  @Override    
  7. public boolean addUser(AddUserForm userForm) {    
  8.     User user = new User();    
  9.     user.setNickname(userForm.getNickname());    
  10.     user.setBirthday(userForm.getBirthday());    
  11.     user.setUsername(userForm.getUsername());    
  12.     user.setPassword(userForm.getPassword());    
  13.     return save(user);    
  14. }   

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

  1. /**    
  2.  * 添加用戶    
  3.  * @param userForm 表單數據    
  4.  * @return true 或者 false    
  5.  */    
  6. @Override    
  7. public boolean addUser(AddUserForm userForm) {    
  8.     User user = new User();    
  9.     BeanUtils.copyProperties(this,user);    
  10.     return save(user);    
  11. }   

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

  1. @Data    
  2. @EqualsAndHashCode(callSuper = false)    
  3. public class AddUserForm extends BaseForm<User> {    
  4.     /**    
  5.      * 昵稱    
  6.      */    
  7.     private String nickname;    
  8.     /**    
  9.      * 生日    
  10.      */    
  11.     private Date birthday;    
  12.     /**    
  13.      * 用戶名    
  14.      */    
  15.     private String username;    
  16.     /**    
  17.      * 密碼    
  18.      */    
  19.     private String password;    
  20.     /**    
  21.      * 構造實體    
  22.      * @return 實體對象    
  23.      */    
  24.     @Override    
  25.     public User buildEntity() {   
  26.         User user = new User();    
  27.         BeanUtils.copyProperties(this,user);    
  28.         return user;    
  29.     }    
  30. }    
  1. /**    
  2.  * 添加用戶    
  3.  * @param userForm 表單數據    
  4.  * @return true 或者 false    
  5.  */    
  6. @Override    
  7. public boolean addUser(AddUserForm userForm) {  
  8.     return save(userForm.buildEntity());    
  9. }   

上面的代碼有沒有種似曾相識的感覺，很多情況都是將接受到的參數，轉變成對應的實體類然后「保存」或者「更新」。

所以對于這類的form可以繼承baseform并實現buildEntity()這樣可以更加符合面向對象，service不需要關心form如何轉變成entity,只需要在使用的時候調用buildEntity()即可，尤其是在form -> entity相對復雜的時候，這樣做可以減少service內的代碼。讓代碼邏輯看起來更加清晰。

通用的分頁對象

涉及到查詢的時候，絕大多數都需要用到分頁，所以說封裝分頁對象就很有必要。可以注意下 PageForm.calcCurrent()、PageVo.setCurrentAndSize()、PageVo.setTotal()這個幾個方法。

PageForm 

  1. @Data    
  2. @ApiModel(value = "分頁數據", description = "分頁需要的表單數據")    
  3. public class PageForm<T extends PageForm<?>>{    
  4.     /**    
  5.      * 頁碼    
  6.      */    
  7.     @ApiModelProperty(value = "頁碼 從第一頁開始 1")    
  8.     @Min(value = 1, message = "頁碼輸入有誤")    
  9.     private Integer current;    
  10.     /**    
  11.      * 每頁顯示的數量    
  12.      */    
  13.     @ApiModelProperty(value = "每頁顯示的數量 范圍在1~100")    
  14.     @Range(min = 1, max = 100, message = "每頁顯示的數量輸入有誤")    
  15.     private Integer size;    
  16.     /**    
  17.      * 計算當前頁 ,方便mysql 進行分頁查詢    
  18.      * @return 返回 pageForm    
  19.      */    
  20.     @ApiModelProperty(hidden = true)    
  21.     public T calcCurrent(){    
  22.         current = (current - 1 ) * size;    
  23.         return (T) this;    
  24.     }    
  25. }   

PageVo 

  1. @Data    
  2. public class PageVo<T> {   
  3.     /**    
  4.      * 分頁數據    
  5.      */    
  6.     @ApiModelProperty(value = "分頁數據")    
  7.     private List<T> records;    
  8.     /**    
  9.      * 總條數    
  10.      */    
  11.     @ApiModelProperty(value = "總條數")    
  12.     private Integer total;    
  13.     /**    
  14.      * 總頁數    
  15.      */    
  16.     @ApiModelProperty(value = "總頁數")    
  17.     private Integer pages;    
  18.     /**    
  19.      * 當前頁    
  20.      */    
  21.     @ApiModelProperty(value = "當前頁")    
  22.     private Integer current;    
  23.     /**    
  24.      * 查詢數量    
  25.      */    
  26.     @ApiModelProperty(value = "查詢數量")    
  27.     private Integer size;    
  28.     /**    
  29.      * 設置當前頁和每頁顯示的數量    
  30.      * @param pageForm 分頁表單    
  31.      * @return 返回分頁信息   
  32.       */   
  33.     @ApiModelProperty(hidden = true)    
  34.     public PageVo<T> setCurrentAndSize(PageForm<?> pageForm){    
  35.         BeanUtils.copyProperties(pageForm,this);    
  36.         return this;    
  37.     }    
  38.     /**    
  39.      * 設置總記錄數    
  40.      * @param total 總記錄數    
  41.      */    
  42.     @ApiModelProperty(hidden = true)    
  43.     public void setTotal(Integer total) {    
  44.         this.total = total;    
  45.         this.setPages(this.total % this.size > 0 ? this.total / this.size + 1 : this.total / this.size);    
  46.     }    
  47. }   

案例

ListUserForm 

  1. @Data    
  2. @ApiModel("獲取用戶列表需要的表單數據")   
  3. @EqualsAndHashCode(callSuper = false)    
  4. public class ListUserForm extends PageForm<ListUserForm> {    
  5.     /**    
  6.      * 用戶狀態    
  7.      */    
  8.     @ApiModelProperty("用戶狀態")    
  9.     @NotEmpty(message = "用戶狀態不能為空")    
  10.     @Range(min =  -1 , max = 1 , message = "用戶狀態有誤")    
  11.     private String status;    
  12. }   

UserServiceImpl 

  1. /**    
  2.  * 獲取用戶列表    
  3.  * @param listUserForm 表單數據    
  4.  * @return 用戶列表    
  5.  */    
  6. @Override    
  7. public PageVo<UserVo> listUser(ListUserForm listUserForm) {   
  8.     PageVo<UserVo> pageVo = new PageVo<UserVo>().setCurrentAndSize(listUserForm);   
  9.     pageVo.setTotal(countUser(listUserForm.getStatus()));    
  10.     pageVo.setRecords(userMapper.listUser(listUserForm.calcCurrent()));    
  11.     return pageVo;    
  12. }    
  13. /**    
  14.  * 獲取用戶數量    
  15.  * @param status 狀態    
  16.  * @return 用戶數量    
  17.  */    
  18. private Integer countUser(String status){    
  19.     return count(new QueryWrapper<User>().eq("status",status));    
  20. }   

UserController 

  1. /**    
  2.  * 獲取用戶列表    
  3.  * @param listUserForm 表單數據    
  4.  * @return 用戶列表    
  5.  */    
  6. @ApiOperation("獲取用戶列表")    
  7. @GetMapping("/listUser")    
  8. @ApiResponses(    
  9.         @ApiResponse(code = 200, message = "操作成功", response = UserVo.class)    
  10. )    
  11. public ResultVo listUser(@Validated ListUserForm listUserForm){   
  12.     return ResultVoUtil.success(userService.listUser(listUserForm));    
  13. }   

注意的點

  •  PageVo在實例化的時候需要設置「當前頁」和「每頁顯示的數量」 可以調用setCurrentAndSize()完成。
  •  進行分頁查詢的時候，需要計算偏移量。listUserForm.calcCurrent()

為什么要計算偏移量呢？

  •  假如查詢第1頁每頁顯示10條記錄，前端傳遞過來的參數是current=1&amp;&amp;size=10，這個時候limit 1,10沒有問題。
  •  假如查詢第2頁每頁顯示10條記錄，前端傳遞過來的參數是current=2&amp;&amp;size=10，這個時候limit 2,10就有問題，實際應該是limit 10,10。calcCurrent()的作用就是如此。

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

    ❝    自帶的分頁查詢在大量數據下，會出現性能問題。    ❞

常用工具類

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

推薦閱讀：國人開源了一款小而全的 Java 工具類庫

異常處理

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

  •  異常信息拋出 -> ControllerAdvice 進行捕獲格式化輸出內容
  •  手動拋出CustomException并傳入ReulstEnum ——> 進行捕獲錯誤信息輸出錯誤信息。

自定義異常 

  1. @Data    
  2. @EqualsAndHashCode(callSuper = false)  
  3. public class CustomException extends RuntimeException {    
  4.     /**    
  5.      * 狀態碼    
  6.      */    
  7.     private final Integer code;  
  8.     /**    
  9.      * 方法名稱    
  10.      */    
  11.     private final String method;    
  12.     /**    
  13.      * 自定義異常    
  14.      *    
  15.      * @param resultEnum 返回枚舉對象    
  16.      * @param method     方法    
  17.      */    
  18.     public CustomException(ResultEnum resultEnum, String method) {    
  19.         super(resultEnum.getMsg());    
  20.         this.code = resultEnum.getCode();   
  21.          this.method = method;    
  22.     }    
  23.     /**    
  24.      * @param code    狀態碼   
  25.      * @param message 錯誤信息    
  26.      * @param method  方法    
  27.      */    
  28.     public CustomException(Integer code, String message, String method) {    
  29.         super(message);   
  30.         this.code = code;    
  31.         this.method = method;   
  32.      }    
  33. }   

錯誤信息枚舉

根據業務進行添加。 

  1. @Getter    
  2. public enum ResultEnum {    
  3.     /**    
  4.      * 未知異常  
  5.      */    
  6.     UNKNOWN_EXCEPTION(100, "未知異常"),    
  7.     /**    
  8.      * 添加失敗    
  9.      */    
  10.     ADD_ERROR(103, "添加失敗"),    
  11.     /**    
  12.      * 更新失敗    
  13.      */    
  14.     UPDATE_ERROR(104, "更新失敗"),    
  15.     /**    
  16.      * 刪除失敗    
  17.      */    
  18.     DELETE_ERROR(105, "刪除失敗"), 
  19.     /**    
  20.      * 查找失敗    
  21.      */    
  22.     GET_ERROR(106, "查找失敗"),    
  23.     ;    
  24.     private Integer code;    
  25.     private String msg;    
  26.     ResultEnum(Integer code, String msg) {    
  27.         this.code = code;    
  28.         this.msg = msg;    
  29.     }   
  30.     /**    
  31.      * 通過狀態碼獲取枚舉對象    
  32.      * @param code 狀態碼    
  33.      * @return 枚舉對象    
  34.      */    
  35.     public static ResultEnum getByCode(int code){    
  36.         for (ResultEnum resultEnum : ResultEnum.values()) {    
  37.             if(code == resultEnum.getCode()){    
  38.                 return resultEnum;    
  39.             }    
  40.         }    
  41.         return null;   
  42.     }    
  43. }   

全局異常攔截

全局異常攔截是使用@ControllerAdvice進行實現，常用的異常攔截配置可以查看 GlobalExceptionHandling。 

  1. @Slf4j    
  2. @RestControllerAdvice   
  3. public class GlobalExceptionHandling {   
  4.     /**    
  5.      * 自定義異常    
  6.      */    
  7.     @ExceptionHandler(value = CustomException.class)    
  8.     public ResultVo processException(CustomException e) { 
  9.         log.error("位置:{} -> 錯誤信息:{}", e.getMethod() ,e.getLocalizedMessage());   
  10.         return ResultVoUtil.error(Objects.requireNonNull(ResultEnum.getByCode(e.getCode())));    
  11.     }    
  12.     /**    
  13.      * 通用異常    
  14.      */    
  15.     @ResponseStatus(HttpStatus.OK)    
  16.     @ExceptionHandler(Exception.class)   
  17.     public ResultVo exception(Exception e) {    
  18.         e.printStackTrace();    
  19.         return ResultVoUtil.error(ResultEnum.UNKNOWN_EXCEPTION);    
  20.     }    
  21. }   

案例

Controller 

  1. /**    
  2.  * 刪除用戶    
  3.  * @param id 用戶編號    
  4.  * @return 成功或者失敗   
  5.  */    
  6. @ApiOperation("刪除用戶")  
  7. @DeleteMapping("/deleteUser/{id}")    
  8. public ResultVo deleteUser(@PathVariable("id") String id){   
  9.     userService.deleteUser(id);    
  10.     return ResultVoUtil.success();    
  11. }   

Service 

  1. /**    
  2.  * 刪除用戶    
  3.  * @param id id    
  4.  */    
  5. @Override    
  6. public void deleteUser(String id) {    
  7.     // 如果刪除失敗拋出異常。 -- 演示而已不推薦這樣干    
  8.     if(!removeById(id)){    
  9.         throw new CustomException(ResultEnum.DELETE_ERROR, MethodUtil.getLineInfo());   
  10.     }    
  11. }   

結果

「將報錯代碼所在的文件第多少行都打印出來。方便排查。」

注意的點

所有手動拋出的錯誤信息，都應在錯誤信息枚舉ResultEnum進行統一維護。不同的業務使用不同的錯誤碼。方便在報錯時進行分辨。快速定位問題。

多環境配置

SpringBoot多環境配置

對于一個項目來講基本都4有個環境dev,test,pre,prod，對于SpringBoot項目多建立幾個配置文件就可以了。

然后啟動的時候可以通過配置spring.profiles.active 來選擇啟動的環境。這個詳細教程請關注公眾號Java技術棧回復boot獲取系列教程。

 

  1. java -jar BasicProject.jar --spring.profiles.active=prod   

Maven多環境配置

假如想在打包的時候動態指定環境，這個時候就需要借助Maven的xml來實現。這個請關注公眾號Java技術棧回復mvn獲取一份完整詳細教程。

配置XML 

  1. <!--  配置環境  -->    
  2. <profiles>    
  3.     <profile>    
  4.         <!-- 開發 -->    
  5.         <id>dev</id>    
  6.         <activation>    
  7.             <activeByDefault>true</activeByDefault>    
  8.         </activation>    
  9.         <properties>    
  10.             <activatedProperties>dev</activatedProperties>  
  11.         </properties>    
  12.     </profile>    
  13.     <profile>    
  14.         <!-- 測試 -->    
  15.         <id>test</id>    
  16.         <properties>    
  17.             <activatedProperties>test</activatedProperties>    
  18.         </properties>    
  19.     </profile>    
  20.     <profile>    
  21.         <!-- 準生產 -->    
  22.         <id>pre</id>    
  23.         <properties>    
  24.             <activatedProperties>pre</activatedProperties>    
  25.         </properties>    
  26.     </profile>    
  27.     <profile>    
  28.         <!-- 生產 -->    
  29.         <id>prod</id>    
  30.         <properties>    
  31.             <activatedProperties>prod</activatedProperties>    
  32.         </properties>    
  33.     </profile>    
  34. </profiles>   

更改application.yml 

  1. spring:    
  2.   profiles:  
  3.      # 選擇環境    
  4.     active: @activatedProperties@   

使用案例 

  1. mvn clean package -P prod   
  2. mvn clean package -P pre    
  3. mvn clean package -P test   

打包完可以解壓開查看application.yml 會發現spring.profiles.active=@activatedProperties@ 發生了改變。

日志配置

采用logback日志配置，點擊這里參考這篇文章。

JenkinsFile

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

結尾

如果覺得對你有幫助，可以隨手點個在看哦，謝謝。 

 

責任編輯：龐桂玉 來源： Java技術棧
Spring Boot代碼Java
相關推薦

2020-11-13 07:08:51

Spring Boot應用Spring

2022-06-06 08:42:04

spring-boo開發接口防盜刷

2020-09-27 14:13:50

Spring BootJava框架

2022-06-23 08:42:08

配置加密解密

2019-07-15 11:04:37

Spring BootTomcat開發

2021-05-06 10:52:09

Java Spring Bo框架

2014-07-02 10:03:42

App推廣渠道

2020-06-22 07:55:28

接口爬蟲

2022-05-09 11:01:18

配置文件數據庫

2023-10-18 15:25:29

數據源數據庫

2023-04-28 12:01:56

Spring項目編譯

2024-11-11 11:30:34

2022-09-22 13:28:34

Redis分布式鎖

2024-02-04 09:19:00

Nacos動態化線程池

2022-09-29 08:28:57

SpringRedis分布式

2024-11-08 14:11:09

2020-03-16 17:20:02

異常處理Spring Boot

2011-03-24 09:34:41

SPRING

2025-03-11 09:00:00

Spring依賴注入Java

2025-03-26 00:35:00

Javaweb開發
點贊
收藏

51CTO技術棧公眾號

主站蜘蛛池模板： 99精品网| 国产成人综合在线 | 亚洲a一区 | 日韩久久久久 | 亚洲一区网站 | 国产精品久久久久久久久久久久久久 | 久久久精品国产 | 亚洲精品中文字幕在线观看 | 国产在线a | 欧洲精品一区 | 九九免费观看视频 | 国产精品天堂 | 在线观看免费av片 | 日本精品一区二区三区在线观看 | 成人在线观 | 欧美精品日韩精品国产精品 | 国产一区二区三区在线观看免费 | av午夜电影 | 国产在线观看不卡一区二区三区 | 中文字幕第一页在线 | 久久久久久99 | 在线播放国产一区二区三区 | 国产免费一级一级 | 黄色在线网站 | 免费中文字幕 | 欧美性高潮 | 午夜成人免费视频 | 国产精品视频一区二区三区 | 欧洲妇女成人淫片aaa视频 | 欧美一二三四成人免费视频 | 中文字幕一区二区三区四区五区 | 国产欧美精品一区 | 欧美精品久久久 | 香蕉视频一区二区 | 欧美一区二区三区在线观看 | 国产乱码久久久 | 精品伊人 | 国产精品久久久久久影视 | 黄色片亚洲 | 本地毛片 | 国产精品视频网 |