日韩无码专区无码一级三级片|91人人爱网站中日韩无码电影|厨房大战丰满熟妇|AV高清无码在线免费观看|另类AV日韩少妇熟女|中文日本大黄一级黄色片|色情在线视频免费|亚洲成人特黄a片|黄片wwwav色图欧美|欧亚乱色一区二区三区

RELATEED CONSULTING
相關(guān)咨詢
選擇下列產(chǎn)品馬上在線溝通
服務(wù)時(shí)間：8:30-17:00
你可能遇到了下面的問(wèn)題
關(guān)閉右側(cè)工具欄

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營(yíng)銷解決方案
Java項(xiàng)目構(gòu)建基礎(chǔ)：統(tǒng)一結(jié)果，統(tǒng)一異常，統(tǒng)一日志

在開發(fā)過(guò)程中，為了提升開發(fā)效率，提升代碼規(guī)范，我們會(huì)將返回結(jié)果，異常以及日志進(jìn)行統(tǒng)一封裝處理，接下來(lái)我們一起來(lái)看看如何實(shí)現(xiàn)。

專注于為中小企業(yè)提供網(wǎng)站制作、成都做網(wǎng)站服務(wù),電腦端+手機(jī)端+微信端的三站合一,更高效的管理,為中小企業(yè)佛山免費(fèi)做網(wǎng)站提供優(yōu)質(zhì)的服務(wù)。我們立足成都，凝聚了一批互聯(lián)網(wǎng)行業(yè)人才，有力地推動(dòng)了數(shù)千家企業(yè)的穩(wěn)健成長(zhǎng)，幫助中小企業(yè)通過(guò)網(wǎng)站建設(shè)實(shí)現(xiàn)規(guī)模擴(kuò)充和轉(zhuǎn)變。

統(tǒng)一結(jié)果返回

目前的前后端開發(fā)大部分?jǐn)?shù)據(jù)的傳輸格式都是json，因此定義一個(gè)統(tǒng)一規(guī)范的數(shù)據(jù)格式有利于前后端的交互與UI的展示。

1. 統(tǒng)一結(jié)果的一般形式

  • 是否響應(yīng)成功；
  • 響應(yīng)狀態(tài)碼；
  • 狀態(tài)碼描述；
  • 響應(yīng)數(shù)據(jù)；
  • 其他標(biāo)識(shí)符。

2. 結(jié)果類枚舉

前三者可定義結(jié)果枚舉，如：success，code，message

@Getter
public enum ResultCodeEnum {
    SUCCESS(true,20000,"成功"),
    UNKNOWN_ERROR(false,20001,"未知錯(cuò)誤"),,
    PARAM_ERROR(false,20002,"參數(shù)錯(cuò)誤"),
    ;

    // 響應(yīng)是否成功
    private Boolean success;
    // 響應(yīng)狀態(tài)碼
    private Integer code;
    // 響應(yīng)信息
    private String message;

    ResultCodeEnum(boolean success, Integer code, String message) {
        this.success = success;
        this.code = code;
        this.message = message;
    }
}

3. 統(tǒng)一結(jié)果類

第5個(gè)屬于自定義返回，利用前4者可定義統(tǒng)一返回對(duì)象。

注意：

  • 外接只可以調(diào)用統(tǒng)一返回類的方法，不可以直接創(chuàng)建，影刺構(gòu)造器私有；
  • 內(nèi)置靜態(tài)方法，返回對(duì)象；
  • 為便于自定義統(tǒng)一結(jié)果的信息，建議使用鏈?zhǔn)骄幊?，將返回?duì)象設(shè)類本身，即return this；
  • 響應(yīng)數(shù)據(jù)由于為json格式，可定義為JsonObject或Map形式；
@Data
public class R {
    private Boolean success;

    private Integer code;

    private String message;

    private Map data = new HashMap<>();

    // 構(gòu)造器私有
    private R(){}

    // 通用返回成功
    public static R ok() {
        R r = new R();
        r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
        r.setCode(ResultCodeEnum.SUCCESS.getCode());
        r.setMessage(ResultCodeEnum.SUCCESS.getMessage());
        return r;
    }

    // 通用返回失敗，未知錯(cuò)誤
    public static R error() {
        R r = new R();
        r.setSuccess(ResultCodeEnum.UNKNOWN_ERROR.getSuccess());
        r.setCode(ResultCodeEnum.UNKNOWN_ERROR.getCode());
        r.setMessage(ResultCodeEnum.UNKNOWN_ERROR.getMessage());
        return r;
    }

    // 設(shè)置結(jié)果，形參為結(jié)果枚舉
    public static R setResult(ResultCodeEnum result) {
        R r = new R();
        r.setSuccess(result.getSuccess());
        r.setCode(result.getCode());
        r.setMessage(result.getMessage());
        return r;
    }

    /**------------使用鏈?zhǔn)骄幊蹋祷仡惐旧?----------**/

    // 自定義返回?cái)?shù)據(jù)
    public R data(Map map) {
        this.setData(map);
        return this;
    }

    // 通用設(shè)置data
    public R data(String key,Object value) {
        this.data.put(key, value);
        return this;
    }

    // 自定義狀態(tài)信息
    public R message(String message) {
        this.setMessage(message);
        return this;
    }

    // 自定義狀態(tài)碼
    public R code(Integer code) {
        this.setCode(code);
        return this;
    }

    // 自定義返回結(jié)果
    public R success(Boolean success) {
        this.setSuccess(success);
        return this;
    }
}

4. 控制層返回

視圖層使用統(tǒng)一結(jié)果：

@RestController
@RequestMapping("/api/v1/users")
public class TeacherAdminController {

    @Autowired
    private UserService userService;

    @GetMapping
    public R list() {
        List list = teacherService.list(null);
        return R.ok().data("itms", list).message("用戶列表");
    }
}

json結(jié)果：

{
  "success": true,
  "code": 20000,
  "message": "查詢用戶列表",
  "data": {
    "itms": [
      {
        "id": "1",
        "username": "admin",
        "role": "ADMIN",
        "deleted": false,
        "gmtCreate": "2019-12-26T15:32:29",
        "gmtModified": "2019-12-26T15:41:40"
      },{
        "id": "2",
        "username": "zhangsan",
        "role": "USER",
        "deleted": false,
        "gmtCreate": "2019-12-26T15:32:29",
        "gmtModified": "2019-12-26T15:41:40"
      }
    ]
  }
}

統(tǒng)一結(jié)果類的使用參考了mybatis-plus中R對(duì)象的設(shè)計(jì)。

統(tǒng)一異常處理

使用統(tǒng)一返回結(jié)果時(shí)，還有一種情況，就是程序的保存是由于運(yùn)行時(shí)異常導(dǎo)致的結(jié)果，有些異常我們可以無(wú)法提前預(yù)知，不能正常走到我們r(jià)eturn的R對(duì)象返回。

因此，我們需要定義一個(gè)統(tǒng)一的全局異常來(lái)捕獲這些信息，并作為一種結(jié)果返回控制層。

1. @ControllerAdvice

該注解為統(tǒng)一異常處理的核心：

是一種作用于控制層的切面通知(Advice)，該注解能夠?qū)⑼ㄓ玫腀ExceptionHandler、@InitBinder和@ModelAttributes方法收集到一個(gè)類型，并應(yīng)用到所有控制器上。

該類中的設(shè)計(jì)思路：

  • 使用@ExceptionHandler注解捕獲指定或自定義的異常；
  • 使用@ControllerAdvice集成@ExceptionHandler的方法到一個(gè)類中；
  • 必須定義一個(gè)通用的異常捕獲方法，便于捕獲未定義的異常信息；
  • 自定一個(gè)異常類，捕獲針對(duì)項(xiàng)目或業(yè)務(wù)的異常；
  • 異常的對(duì)象信息補(bǔ)充到統(tǒng)一結(jié)果枚舉中；

2. 自定義全局異常類

@Data
public class CMSException extends RuntimeException {
    private Integer code;

    public CMSException(Integer code, String message) {
        super(message);
        this.code = code;
    }

    public CMSException(ResultCodeEnum resultCodeEnum) {
        super(resultCodeEnum.getMessage());
        this.code = resultCodeEnum.getCode();
    }

    @Override
    public String toString() {
        return "CMSException{" + "code=" + code + ", message=" + this.getMessage() + '}';
    }
}

3. 統(tǒng)一異常處理器

// ...
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
public class GlobalExceptionHandler {

    /**-------- 通用異常處理方法 --------**/
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e) {
        e.printStackTrace();
        return R.error(); // 通用異常結(jié)果
    }

    /**-------- 指定異常處理方法 --------**/
    @ExceptionHandler(NullPointerException.class)
    @ResponseBody
    public R error(NullPointerException e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.NULL_POINT);
    }

    @ExceptionHandler(HttpClientErrorException.class)
    @ResponseBody
    public R error(IndexOutOfBoundsException e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.HTTP_CLIENT_ERROR);
    }

    /**-------- 自定義定異常處理方法 --------**/
    @ExceptionHandler(CMSException.class)
    @ResponseBody
    public R error(CMSException e) {
        e.printStackTrace();
        return R.error().message(e.getMessage()).code(e.getCode());
    }
}

4. 控制層展示

以下為展示當(dāng)遇到null指定異常時(shí)，返回的結(jié)果信息：

{
  "success": false,
  "code": 20007,
  "message": "空指針異常",
  "data": {}
}

統(tǒng)一日志收集

日志是追蹤錯(cuò)誤定位問(wèn)題的關(guān)鍵，尤其在生產(chǎn)環(huán)境中，需要及時(shí)修復(fù)熱部署，不會(huì)提供開發(fā)者debug的環(huán)境，此時(shí)日志將會(huì)是最快解決問(wèn)題的關(guān)鍵

日志的框架比較豐富，由于spring boot對(duì)logback的集成，因此推薦使用logback在項(xiàng)目中使用。

1. Logback

關(guān)于logback的配置和介紹，可以參考官網(wǎng)。

2. 配置

以下直接貼出配置信息，介紹信息科直接參考備注：







    logback

    
    

    
    
    
    
    
    
    

    
    
        
        
            debug
        
        
            ${CONSOLE_LOG_PATTERN}
            
            UTF-8
        
    

    
    
    
        
        ${log.path}/edu_debug.log
        
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            UTF-8 
        
        
        
            
            ${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log
            
                100MB
            
            
            15
        
        
        
            debug
            ACCEPT
            DENY
        
    

    
    
        
        ${log.path}/edu_info.log
        
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            UTF-8
        
        
        
            
            ${log.path}/web-info-%d{yyyy-MM-dd}.%i.log
            
                100MB
            
            
            15
        
        
        
            info
            ACCEPT
            DENY
        
    

    
    
        
        ${log.path}/edu_warn.log
        
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            UTF-8 
        
        
        
            ${log.path}/web-warn-%d{yyyy-MM-dd}.%i.log
            
                100MB
            
            
            15
        
        
        
            warn
            ACCEPT
            DENY
        
    

    
    
        
        ${log.path}/edu_error.log
        
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            UTF-8