SpringBoot項(xiàng)目中Controller層代碼編寫規(guī)范整理方式
Controller層代碼規(guī)范
主要的內(nèi)容是就是接口定義里面的內(nèi)容,你只要遵循里面的規(guī)范,controller就問題不大,除了這些,還有另外的幾點(diǎn):
- 所有函數(shù)返回統(tǒng)一的ResultBean/PageResultBean格式;
- 沒有統(tǒng)一格式,AOP無(wú)法玩.
- ResultBean/PageResultBean是controller專用的,不允許往后傳
- Controller做參數(shù)格式的轉(zhuǎn)換,不允許把json,map這類對(duì)象傳到services去,也不允許services返回json、map。
SpringMVC接口定義要注意以下常見的幾種問題
1. 返回格式不統(tǒng)一
同一個(gè)接口,有時(shí)候返回?cái)?shù)組,有時(shí)候返回單個(gè);成功的時(shí)候返回對(duì)象,失敗的時(shí)候返回錯(cuò)誤信息字符串。工作中有個(gè)系統(tǒng)集成就是這樣定義的接口,真是辣眼睛。
這個(gè)對(duì)應(yīng)代碼上,返回的類型是map,json,object,都是不應(yīng)該的。實(shí)際工作中,我們會(huì)定義一個(gè)統(tǒng)一的格式,就是ResultBean,分頁(yè)的有另外一個(gè)PageResultBean
錯(cuò)誤范例:
//返回map可讀性不好,盡量不要
@PostMapping("/delete")
public Map<String, Object> delete(long id, String lang) { }
// 成功返回boolean,失敗返回string,大忌
@PostMapping("/delete")
public Objectdelete(long id, String lang) {
try {
boolean result = configService.delete(id, local); return result;
} catch (Exception e) {
log.error(e); return e.toString();
}
}
2. 沒有考慮失敗情況
一開始只考慮成功場(chǎng)景,等后面測(cè)試發(fā)現(xiàn)有錯(cuò)誤情況,怎么辦,改接口唄,前后臺(tái)都改,勞民傷財(cái)無(wú)用功。
錯(cuò)誤范例:
//不返回任何數(shù)據(jù),沒有考慮失敗場(chǎng)景,容易返工
@PostMapping("/update") public void update(long id, xxx) { }
3. 出現(xiàn)和業(yè)務(wù)無(wú)關(guān)的輸入?yún)?shù)
如lang語(yǔ)言,當(dāng)前用戶信息 都不應(yīng)該出現(xiàn)參數(shù)里面,應(yīng)該從當(dāng)前會(huì)話里面獲取。后面講ThreadLocal會(huì)說(shuō)到怎么樣去掉。除了代碼可讀性不好問題外,尤其是參數(shù)出現(xiàn)當(dāng)前用戶信息的,這是個(gè)嚴(yán)重問題。
錯(cuò)誤范例:
// (當(dāng)前用戶刪除數(shù)據(jù))參數(shù)出現(xiàn)lang和userid,尤其是userid,大忌
@PostMapping("/delete")
public Map<String, Object> delete(long id,String lang, String userId) { }
4. 出現(xiàn)復(fù)雜的輸入?yún)?shù)
一般情況下,不允許出現(xiàn)例如json字符串這樣的參數(shù),這種參數(shù)可讀性極差。應(yīng)該定義對(duì)應(yīng)的bean。
錯(cuò)誤范例:
// 參數(shù)出現(xiàn)json格式,可讀性不好,代碼也難看
@PostMapping("/update") public Map<String, Object> update(long id, String jsonStr) { }
5. 沒有返回應(yīng)該返回的數(shù)據(jù)
例如,新增接口一般情況下應(yīng)該返回新對(duì)象的id標(biāo)識(shí),這需要編程經(jīng)驗(yàn)。新手定義的時(shí)候因?yàn)榍芭_(tái)沒有用就不返回?cái)?shù)據(jù)或者只返回true,這都是不恰當(dāng)?shù)摹e人要不要是別人的事情,你該返回的還是應(yīng)該返回。
錯(cuò)誤范例:
// 約定俗成,新建應(yīng)該返回新對(duì)象的信息,只返回boolean容易導(dǎo)致返工
@PostMapping("/add")
public boolean add(xxx) { //xxx return configService.add(); }
很多人看了我的這篇文章程序員你為什么這么累?都覺得里面的技術(shù)也很簡(jiǎn)單,沒有什么特別的地方,但是,實(shí)現(xiàn)這個(gè)代碼框架之前,就是要你的接口的統(tǒng)一的格式ResultBean,aop才好做。有些人誤解了,我那篇文章說(shuō)的都不是技術(shù),重點(diǎn)說(shuō)的是編碼習(xí)慣工作方式,如果你重點(diǎn)還是放在什么技術(shù)上,那我也幫不了你了。同樣,如果我后面的關(guān)于習(xí)慣和規(guī)范的帖子,你重點(diǎn)還是放在技術(shù)上的話,那是丟了西瓜撿芝麻,有很多貼還是沒有任何技術(shù)點(diǎn)呢。
附上ResultBean,沒有任何技術(shù)含量:
/**
* Controller統(tǒng)一返回對(duì)象,響應(yīng)信息主體
*/
@Getter
@ApiModel(value = "響應(yīng)信息主體")
public class R<T> implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 狀態(tài)碼:1成功,其他均為失敗【詳見錯(cuò)誤狀態(tài)碼表】
*/
@ApiModelProperty(value = "狀態(tài)碼")
private int code;
/**
* 成功為success,其他為失敗原因
*/
@ApiModelProperty(value = "消息")
private Object message = "success";
/**
* 數(shù)據(jù)結(jié)果集
*/
@ApiModelProperty(value = "數(shù)據(jù)結(jié)果集")
private T data;
/**
* 當(dāng)前時(shí)間
*/
@ApiModelProperty(value = "時(shí)間戳")
private final long time = System.currentTimeMillis();
public R<T> setMessage(Object message) {
this.message = message;
return this;
}
public R<T> setMessage(String format, Object... args) {
this.message = new Formatter().format(format, args).toString();
return this;
}
public R() {
}
/**
* 使用枚舉類中模版消息
*
* @param resultConstant ResultConstant
* @param data 數(shù)據(jù)結(jié)果集
*/
private R(ResultConstant resultConstant, T data) {
this.code = resultConstant.getCode();
this.message = resultConstant.getMessage();
this.data = data;
}
public static <T> R<T> ok() {
return restResult(ResultConstant.SUCCESS, null, null);
}
public static <T> R<T> ok(T data) {
return restResult(ResultConstant.SUCCESS, null, data);
}
public static <T> R<T> ok(T data, Object message) {
return restResult(ResultConstant.SUCCESS, message, data);
}
public static <T> R<T> failed(ResultConstant resultConstant) {
return restResult(resultConstant, null, null);
}
public static <T> R<T> failed(ResultConstant resultConstant, Object message) {
return restResult(resultConstant, message, null);
}
public static <T> R<T> failed(ResultConstant resultConstant, Object message, T data) {
return restResult(resultConstant, message, data);
}
private static <T> R<T> restResult(ResultConstant resultConstant, Object message, T data) {
R<T> apiResult = new R<>(resultConstant, data);
if (null != message) {
apiResult.setMessage(message);
}
return apiResult;
}
}
統(tǒng)一的接口規(guī)范,能幫忙規(guī)避很多無(wú)用的返工修改和可能出現(xiàn)的問題。能使代碼可讀性更加好,利于進(jìn)行aop和自動(dòng)化測(cè)試這些額外工作。
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
- SpringBoot使用@ControllerAdvice進(jìn)行統(tǒng)一處理異常詳解
- springboot的controller中如何獲取applicatim.yml的配置值
- Springboot中Controller和RestController的使用及區(qū)別
- SpringBoot整合通用mapper實(shí)現(xiàn)泛型BaseController增刪改方式
- springboot項(xiàng)目controller統(tǒng)一返回對(duì)象格式以及全局自定義異常方式
- SpringBoot @RestController注解用法及說(shuō)明
- SpringBoot controller接收txt文本文件實(shí)現(xiàn)方式
相關(guān)文章
使用idea的database模塊繪制數(shù)據(jù)庫(kù)er圖的方法
這篇文章主要介紹了使用idea的database模塊繪制數(shù)據(jù)庫(kù)er圖,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-07-07
Java的無(wú)參構(gòu)造函數(shù)用法實(shí)例分析
這篇文章主要介紹了Java的無(wú)參構(gòu)造函數(shù)用法,結(jié)合實(shí)例形式分析了java無(wú)參構(gòu)造函數(shù)基本原理、用法及相關(guān)操作注意事項(xiàng),需要的朋友可以參考下2019-09-09
IDEA上面搭建一個(gè)SpringBoot的web-mvc項(xiàng)目遇到的問題
這篇文章主要介紹了IDEA上面搭建一個(gè)SpringBoot的web-mvc項(xiàng)目遇到的問題小結(jié),需要的朋友可以參考下2017-04-04
記一次線上SpringCloud Feign請(qǐng)求服務(wù)超時(shí)異常排查問題
這篇文章主要介紹了記一次線上SpringCloud Feign請(qǐng)求服務(wù)超時(shí)異常排查問題,本項(xiàng)目與下游項(xiàng)目均注冊(cè)在Eureka上面,對(duì)這個(gè)1秒就超時(shí)感到很迷惑,于是開始查閱底層源碼之旅。需要的朋友可以參考下2022-01-01
Spring Boot 分布式鎖與并發(fā)控制的應(yīng)用場(chǎng)景
本章主要介紹了SpringBoot分布式鎖與并發(fā)控制的核心概念與使用方法,包括分布式鎖的定義與特點(diǎn)、并發(fā)控制的定義與特點(diǎn)、SpringBoot與分布式鎖的集成、SpringBoot的實(shí)際應(yīng)用場(chǎng)景,感興趣的朋友跟隨小編一起看看吧2026-03-03

