建立一個(gè)全新的項(xiàng)目,或者把舊的龐大的項(xiàng)目咕娄,進(jìn)行拆分成多個(gè)項(xiàng)目亥揖。在建立新的項(xiàng)目中,經(jīng)常需要做一些重復(fù)的工作圣勒,比如說(shuō)拷貝一下常用的工具類费变,通用代碼等等。所以就可以做一個(gè)基礎(chǔ)的項(xiàng)目方便使用圣贸,在經(jīng)歷新項(xiàng)目的時(shí)候挚歧,直接在基礎(chǔ)項(xiàng)目上進(jìn)行簡(jiǎn)單配置就可以開(kāi)發(fā)業(yè)務(wù)代碼了。
基礎(chǔ)項(xiàng)目該包含哪些東西吁峻。
Swagger在線接口文檔滑负。
CodeGenerator 代碼生成器在张。
統(tǒng)一返回。
通用的分頁(yè)對(duì)象矮慕。
常用工具類帮匾。
全局異常攔截。
錯(cuò)誤枚舉痴鳄。
自定義異常瘟斜。
多環(huán)境配置文件。
Maven多環(huán)境配置痪寻。
日志配置螺句。
JenkinsFile。
可以在評(píng)論區(qū)進(jìn)行補(bǔ)充橡类,我把 Spring Boot 相關(guān)的文章整理成了 PDF蛇尚,關(guān)注 Java后端,后臺(tái)回復(fù) 666 下載這本 Java技術(shù)棧手冊(cè)猫态。
Swagger
寫接口文檔通常是一件比較頭疼的事情佣蓉,然而swagger就用是用來(lái)幫我們解決這個(gè)問(wèn)題的∏籽可以在線生成接口文檔勇凭,并且可以在頁(yè)面上進(jìn)行測(cè)試。
可以非常清楚的顯示义辕,請(qǐng)求數(shù)據(jù)已經(jīng)響應(yīng)數(shù)據(jù)虾标。當(dāng)然這一切都需要在代碼中進(jìn)行配置。
常用的Swagger注解
@Api用于Controller
@ApiOperation用于Controller內(nèi)的方法灌砖。
@ApiResponses用于標(biāo)識(shí)接口返回?cái)?shù)據(jù)的類型璧函。
@ApiModel用于標(biāo)識(shí)類的名稱
@ApiModelProperty用于標(biāo)識(shí)屬性的名稱
案例
`@RestController
@Api(tags = "用戶")
@AllArgsConstructor
@RequestMapping("/user")
public class UserController {
private IUserService userService;
@**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("獲取用戶列表需要的表單數(shù)據(jù)")
@EqualsAndHashCode(callSuper = false)
public class ListUserForm extends PageForm<ListUserForm> {
@ApiModelProperty("用戶狀態(tài)")
@NotEmpty(message = "用戶狀態(tài)不能為空")
@Range(min = -1 , max = 1 , message = "用戶狀態(tài)有誤")
private String status;
}對(duì)應(yīng)的swagger的配置可以查看基礎(chǔ)項(xiàng)目?jī)?nèi)的
SwaggerConfiguration.java`.
CodeGenerator代碼生成器。
mybatis_plus代碼生成器可以幫我們生成entity
,service
,serviceImpl
,mapper
,mapper.xml
基显。省去了建立一大堆實(shí)體類的麻煩蘸吓。由于配置太長(zhǎng)這里就不貼出來(lái)了,對(duì)應(yīng)的CodeGenerator的配置可以查看基礎(chǔ)項(xiàng)目?jī)?nèi)的CodeGenerator.java
.
常用的封裝
統(tǒng)一返回 ResultVo
將所有的接口的響應(yīng)數(shù)據(jù)的格式進(jìn)行統(tǒng)一撩幽。`@Data
@ApiModel("固定返回格式")
public class ResultVo {
@ApiModelProperty("錯(cuò)誤碼")
private Integer code;
@ApiModelProperty("提示信息")
private String message;
@ApiModelProperty("響應(yīng)數(shù)據(jù)")
private Object data;
}`
抽象表單 BaseForm
`public abstract class BaseForm<T> {
**public** **abstract** T **buildEntity**();
}`
有小伙伴可能有疑問(wèn)了库继,這個(gè)類有啥用呢。先看一下窜醉,下面的代碼宪萄。
**@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); }
重構(gòu)一下,感覺(jué)清爽了一些榨惰。**@Override** **public** **boolean** **addUser**(AddUserForm userForm) { User user = **new** User(); BeanUtils.copyProperties(**this**,user); **return** save(user); }
使用BaseForm進(jìn)行重構(gòu) 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;
**@Override**
**public** User buildEntity() {
User user = **new** User();
BeanUtils.copyProperties(**this**,user);
**return** user;
}
}
@Override
public boolean addUser(AddUserForm userForm) {
return save(userForm.buildEntity());
}
上面的代碼有沒(méi)有種似曾相識(shí)的感覺(jué)拜英,很多情況都是將接受到的參數(shù),轉(zhuǎn)變成對(duì)應(yīng)的實(shí)體類然后保存或者更新琅催。所以對(duì)于這類的form
可以繼承baseform
并實(shí)現(xiàn)buildEntity()
這樣可以更加符合面向?qū)ο螅?code>service不需要關(guān)心form
如何轉(zhuǎn)變成entity
,只需要在使用的時(shí)候調(diào)用buildEntity()
即可居凶,尤其是在form
-> entity
相對(duì)復(fù)雜的時(shí)候虫给,這樣做可以減少service
內(nèi)的代碼。讓代碼邏輯看起來(lái)更加清晰排监。
通用的分頁(yè)對(duì)象
涉及到查詢的時(shí)候狰右,絕大多數(shù)都需要用到分頁(yè),所以說(shuō)封裝分頁(yè)對(duì)象就很有必要舆床。可以注意下PageForm.calcCurrent()
嫁佳、PageVo.setCurrentAndSize()
挨队、PageVo.setTotal()
這個(gè)幾個(gè)方法。
PageForm
`@Data
@ApiModel(value = "分頁(yè)數(shù)據(jù)", description = "分頁(yè)需要的表單數(shù)據(jù)")
public class PageForm<T extends PageForm<?>>{
**@ApiModelProperty**(value = "頁(yè)碼 從第一頁(yè)開(kāi)始 1")
**@Min**(value = 1, message = "頁(yè)碼輸入有誤")
**private** Integer current;
**@ApiModelProperty**(value = "每頁(yè)顯示的數(shù)量 范圍在1~100")
**@Range**(min = 1, max = 100, message = "每頁(yè)顯示的數(shù)量輸入有誤")
**private** Integer size;
**@ApiModelProperty**(hidden = **true**)
**public** T **calcCurrent**(){
current = (current - 1 ) * size;
**return** (T) **this**;
}
}`
**PageVo**
``@Data
public class PageVo<T> {
@ApiModelProperty(value = "分頁(yè)數(shù)據(jù)")
private List<T> records;
@ApiModelProperty(value = "總條數(shù)")
private Integer total;
@ApiModelProperty(value = "總頁(yè)數(shù)")
private Integer pages;
@ApiModelProperty(value = "當(dāng)前頁(yè)")
private Integer current;
@ApiModelProperty(value = "查詢數(shù)量")
private Integer size;
@ApiModelProperty(hidden = true)
public PageVo<T> setCurrentAndSize(PageForm<?> pageForm){
BeanUtils.copyProperties(pageForm,this);
return this;
}
@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("獲取用戶列表需要的表單數(shù)據(jù)")
@EqualsAndHashCode(callSuper = false)
public class ListUserForm extends PageForm<ListUserForm> {
@ApiModelProperty("用戶狀態(tài)")
@NotEmpty(message = "用戶狀態(tài)不能為空")
@Range(min = -1 , max = 1 , message = "用戶狀態(tài)有誤")
private String status;
}`
UserServiceImpl
`@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;
}
private Integer countUser(String status){
return count(new QueryWrapper<User>().eq("status",status));
}`
UserController
@ApiOperation("獲取用戶列表") @GetMapping("/listUser") @ApiResponses( @ApiResponse(code = 200, message = "操作成功", response = UserVo.class) ) public ResultVo listUser(@Validated ListUserForm listUserForm){ **return** **ResultVoUtil**.success(userService.listUser(listUserForm)); }
注意的點(diǎn)
PageVo在實(shí)例化的時(shí)候需要設(shè)置當(dāng)前頁(yè)和每頁(yè)顯示的數(shù)量 可以調(diào)用
setCurrentAndSize()
完成蒿往。進(jìn)行分頁(yè)查詢的時(shí)候盛垦,需要計(jì)算偏移量。
listUserForm.calcCurrent()
為什么要計(jì)算偏移量呢瓤漏?
假如查詢第1頁(yè)每頁(yè)顯示10條記錄腾夯,前端傳遞過(guò)來(lái)的參數(shù)是
current=1&&size=10
,這個(gè)時(shí)候limit 1,10
沒(méi)有問(wèn)題蔬充。假如查詢第2頁(yè)每頁(yè)顯示10條記錄蝶俱,前端傳遞過(guò)來(lái)的參數(shù)是
current=2&&size=10
,這個(gè)時(shí)候limit 2,10
就有問(wèn)題饥漫,實(shí)際應(yīng)該是limit 10,10
榨呆。calcCurrent()的作用就是如此
。
為什么不用MybatisPlus自帶的分頁(yè)插件呢庸队? 自帶的分頁(yè)查詢?cè)诖罅繑?shù)據(jù)下积蜻,會(huì)出現(xiàn)性能問(wèn)題。
常用工具類
常用工具類可以根據(jù)自己的開(kāi)發(fā)習(xí)慣引入彻消。
異常處理
異常處理的大致流程主要如下竿拆。
異常信息拋出 ->
ControllerAdvice
進(jìn)行捕獲格式化輸出內(nèi)容手動(dòng)拋出
CustomException
并傳入ReulstEnum
——> 進(jìn)行捕獲錯(cuò)誤信息輸出錯(cuò)誤信息。
自定義異常
`@Data
@EqualsAndHashCode(callSuper = false)
public class CustomException extends RuntimeException {
**private** **final** Integer code;
**private** **final** String method;
**public** **CustomException**(ResultEnum resultEnum, String method) {
**super**(resultEnum.getMsg());
**this**.code = resultEnum.getCode();
**this**.method = method;
}
**public** **CustomException**(Integer code, String message, String method) {
**super**(message);
**this**.code = code;
**this**.method = method;
}
}`
錯(cuò)誤信息枚舉
根據(jù)業(yè)務(wù)進(jìn)行添加宾尚。`@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;
}
**public** **static** ResultEnum getByCode(int code){
**for** (ResultEnum resultEnum : ResultEnum.values()) {
**if**(code == resultEnum.getCode()){
**return** resultEnum;
}
}
**return** null;
}
}`
全局異常攔截
全局異常攔截是使用@ControllerAdvice
進(jìn)行實(shí)現(xiàn)丙笋,常用的異常攔截配置可以查看 GlobalExceptionHandling。`@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandling {
@**ExceptionHandler**(**value** = CustomException.class)
public ResultVo processException(CustomException e) {
**log**.error("位置:{} **-**> 錯(cuò)誤信息:{}", **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
@ApiOperation("刪除用戶") @DeleteMapping("/deleteUser/{id}") public ResultVo deleteUser(@PathVariable("id") String id){ **userService**.deleteUser(id); **return** **ResultVoUtil**.success(); }
Service
`@Override
public void deleteUser(String id) {
**if**(!removeById(id)){
**throw** **new** CustomException(ResultEnum.DELETE_ERROR, MethodUtil.getLineInfo());
}
}`
結(jié)果
將報(bào)錯(cuò)代碼所在的文件第多少行都打印出來(lái)央勒。方便排查不见。
注意的點(diǎn)
所有手動(dòng)拋出的錯(cuò)誤信息,都應(yīng)在錯(cuò)誤信息枚舉ResultEnum
進(jìn)行統(tǒng)一維護(hù)崔步。不同的業(yè)務(wù)使用不同的錯(cuò)誤碼稳吮。方便在報(bào)錯(cuò)時(shí)進(jìn)行分辨【簦快速定位問(wèn)題灶似。
多環(huán)境配置
SpringBoot多環(huán)境配置
對(duì)于一個(gè)項(xiàng)目來(lái)講基本都4有個(gè)環(huán)境dev
,test
,pre
,prod
列林,對(duì)于SpringBoot項(xiàng)目多建立幾個(gè)配置文件就可以了。然后啟動(dòng)的時(shí)候可以通過(guò)配置spring.profiles.active
來(lái)選擇啟動(dòng)的環(huán)境酪惭。
java -jar BasicProject.jar --spring.profiles.active=prod
Maven多環(huán)境配置
假如想在打包的時(shí)候動(dòng)態(tài)指定環(huán)境希痴,這個(gè)時(shí)候就需要借助Maven的xml來(lái)實(shí)現(xiàn)。
配置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: # 選擇環(huán)境 active: @activatedProperties@
使用案例
mvn clean **package** -P prod mvn clean **package** -P pre mvn clean **package** -P test
打包完可以解壓開(kāi)查看application.yml
會(huì)發(fā)現(xiàn)spring.profiles.active=@activatedProperties@
發(fā)生了改變春感。
日志配置
采用logback日志配置
JenkinsFile
JenkinsFile肯定顧名思義是給jenkins用的砌创。主要是配置項(xiàng)目根據(jù)如何進(jìn)行構(gòu)建并發(fā)布到不同的環(huán)境。需要去了解pipeline語(yǔ)法鲫懒,以及如何配置jenkins嫩实。JenkinsFileDemo https://gitee.com/huangxunhui/basic_project/blob/master/Jenkinsfile
代碼地址
https://gitee.com/huangxunhui/basic_project.git
Java 的知識(shí)面非常廣,面試問(wèn)的涉及也非常廣泛窥岩,重點(diǎn)包括:Java 基礎(chǔ)甲献、Java 并發(fā),JVM颂翼、MySQL晃洒、數(shù)據(jù)結(jié)構(gòu)、算法朦乏、Spring球及、微服務(wù)、MQ 等等集歇,涉及的知識(shí)點(diǎn)何其龐大桶略,所以我們?cè)趶?fù)習(xí)的時(shí)候也往往無(wú)從下手,今天小編給大家?guī)?lái)一套 Java 面試題诲宇,題庫(kù)非常全面际歼,包括 Java 基礎(chǔ)、Java 集合姑蓝、JVM鹅心、Java 并發(fā)、Spring全家桶纺荧、Redis旭愧、MySQL、Dubbo宙暇、Netty输枯、MQ 等等,包含 Java 后端知識(shí)點(diǎn) 2000 +
資料獲取方式:關(guān)注公眾號(hào):“程序員白楠楠”獲取上述資料