實戰(zhàn)分布式醫(yī)療掛號通用模塊統(tǒng)一返回結果異常日志處理
文章導讀
本系列文章介紹從0開始搭建一個基于分布式的醫(yī)療掛號系統(tǒng)。本次四篇文章完成了醫(yī)院設置微服務模塊的后端接口,為了方便開發(fā),對接口的返回結果、全局異常、全局日志進行了統(tǒng)一處理。 同時,為了方便進行訪問測試,還整合了Swagger2工具,這些通用的模塊中,除了全局日志被放在醫(yī)院設置微服務模塊的配置資源中,其余都統(tǒng)一被抽取在common模塊中。具體實現(xiàn)可參考下面文章:
項目已開源至 https://github.com/Guoqianliang/yygh_parent
一、統(tǒng)一返回結果
在實際開發(fā)中,是一個后端團隊一起開發(fā),每個人做不同的模塊,開發(fā)不同的接口,最終進行調用進而顯示。因此可以把所有返回結果做一個統(tǒng)一的約定。讓所有的接口都返回相同的數(shù)據(jù)格式,這樣利于前端的顯示與解析。
上圖這一操作需要通過統(tǒng)一返回結果類 和統(tǒng)一返回結果狀態(tài)信息類 來實現(xiàn)。
1.統(tǒng)一返回結果類
/** * 全局統(tǒng)一返回結果類 */ @Data @ApiModel(value = "全局統(tǒng)一返回結果") public class Result<T> { @ApiModelProperty(value = "返回碼") private Integer code; @ApiModelProperty(value = "返回消息") private String message; @ApiModelProperty(value = "返回數(shù)據(jù)") private T data; public Result() { } protected static <T> Result<T> build(T data) { Result<T> result = new Result<T>(); if (data != null) { result.setData(data); } return result; } public static <T> Result<T> build(T body, ResultCodeEnum resultCodeEnum) { Result<T> result = build(body); result.setCode(resultCodeEnum.getCode()); result.setMessage(resultCodeEnum.getMessage()); return result; } public static <T> Result<T> build(Integer code, String message) { Result<T> result = build(null); result.setCode(code); result.setMessage(message); return result; } public static <T> Result<T> ok() { return Result.ok(null); } /** * 操作成功 * @param data * @param <T> * @return */ public static <T> Result<T> ok(T data) { Result<T> result = build(data); return build(data, ResultCodeEnum.SUCCESS); } public static <T> Result<T> fail() { return Result.fail(null); } /** * 操作失敗 * @param data * @param <T> * @return */ public static <T> Result<T> fail(T data) { Result<T> result = build(data); return build(data, ResultCodeEnum.FAIL); } public Result<T> message(String msg) { this.setMessage(msg); return this; } public Result<T> code(Integer code) { this.setCode(code); return this; } public boolean isOk() { if (this.getCode().intValue() == ResultCodeEnum.SUCCESS.getCode().intValue()) { return true; } return false; } }
2.統(tǒng)一返回狀態(tài)信息類
/** * 統(tǒng)一返回結果狀態(tài)信息類 */ @Getter public enum ResultCodeEnum { SUCCESS(200, "成功"), FAIL(201, "失敗"), PARAM_ERROR(202, "參數(shù)不正確"), SERVICE_ERROR(203, "服務異常"), DATA_ERROR(204, "數(shù)據(jù)異常"), DATA_UPDATE_ERROR(205, "數(shù)據(jù)版本異常"), LOGIN_AUTH(208, "未登陸"), PERMISSION(209, "沒有權限"), CODE_ERROR(210, "驗證碼錯誤"), // LOGIN_MOBLE_ERROR(211, "賬號不正確"), LOGIN_DISABLED_ERROR(212, "改用戶已被禁用"), REGISTER_MOBLE_ERROR(213, "手機號已被使用"), LOGIN_AURH(214, "需要登錄"), LOGIN_ACL(215, "沒有權限"), URL_ENCODE_ERROR(216, "URL編碼失敗"), ILLEGAL_CALLBACK_REQUEST_ERROR(217, "非法回調請求"), FETCH_ACCESSTOKEN_FAILD(218, "獲取accessToken失敗"), FETCH_USERINFO_ERROR(219, "獲取用戶信息失敗"), //LOGIN_ERROR( 23005, "登錄失敗"), PAY_RUN(220, "支付中"), CANCEL_ORDER_FAIL(225, "取消訂單失敗"), CANCEL_ORDER_NO(225, "不能取消預約"), HOSCODE_EXIST(230, "醫(yī)院編號已經存在"), NUMBER_NO(240, "可預約號不足"), TIME_NO(250, "當前時間不可以預約"), SIGN_ERROR(300, "簽名錯誤"), HOSPITAL_OPEN(310, "醫(yī)院未開通,暫時不能訪問"), HOSPITAL_LOCK(320, "醫(yī)院被鎖定,暫時不能訪問"), ; private Integer code; private String message; private ResultCodeEnum(Integer code, String message) { this.code = code; this.message = message; } }
二、統(tǒng)一異常處理
spring boot 默認情況下會將異常映射到 /error 進行異常處理,這樣的提示十分不友好,下面使用自定義異常處理,可以提供更友好的展示。
1.自定義異常類
/** * 自定義全局異常類 * */ @Data @ApiModel(value = "自定義全局異常類") public class YyghException extends RuntimeException { @ApiModelProperty(value = "異常狀態(tài)碼") private Integer code; /** * 通過狀態(tài)碼和錯誤消息創(chuàng)建異常對象 * @param message * @param code */ public YyghException(String message, Integer code) { super(message); this.code = code; } /** * 接收枚舉類型對象 * @param resultCodeEnum */ public YyghException(ResultCodeEnum resultCodeEnum) { super(resultCodeEnum.getMessage()); this.code = resultCodeEnum.getCode(); } @Override public String toString() { return "YyghException{" + "code=" + code + ", message=" + this.getMessage() + '}'; } }
2.全局異常處理
下面代碼中兩個方法的@ExceptionHandler
注解,分別傳入系統(tǒng)異常Exception類和自定義異常YyghException類,當出現(xiàn)系統(tǒng)異常時會運行系統(tǒng)的Exception方法,當出現(xiàn)自定義異常時會運行YyghException方法。
/** * @Description: 統(tǒng)一異常處理類 * @author Guoqianliang * @date 20:56 - 2021/4/7 */ @ControllerAdvice public class GlobalExceptionHandler { /** * 全局異常處理 * @param e * @return */ @ExceptionHandler(Exception.class) @ResponseBody public Result error(Exception e) { e.printStackTrace(); return Result.fail(); } /** * 自定義異常處理 * @param e * @return */ @ExceptionHandler(YyghException.class) @ResponseBody public Result error(YyghException e) { e.printStackTrace(); return Result.fail(); } }
使用自定義異常時,不會自動調用,需要手動拋出異常,舉例如下:
三、統(tǒng)一日志處理
日志記錄器(Logger)的行為是分等級的,常用的4個級別如下:
DEBUG < INFO < WARN < ERROR
級別越高,打印的信息越多。默認情況下,springboot從控制臺打印出來的日志級別只有INFO及以上級別,通過:logging.level.root=debug
可以修改日志級別。
下面給出一個日志模塊,通過此模板可以將日志持久化到本地文件:
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="10 seconds"> <!-- 日志級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設置為WARN,則低于WARN的信息都不會輸出 --> <!-- scan:當此屬性設置為true時,配置文件如果發(fā)生改變,將會被重新加載,默認值為true --> <!-- scanPeriod:設置監(jiān)測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當scan為true時,此屬性生效。默認的時間間隔為1分鐘。 --> <!-- debug:當此屬性設置為true時,將打印出logback內部日志信息,實時查看logback運行狀態(tài)。默認值為false。 --> <contextName>logback</contextName> <!-- name的值是變量的名稱,value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義變量后,可以使“${}”來使用變量。 --> <property name="log.path" value="E:/IntelliJ_IDEA/workspace/yygh_parent/yygh_log"/> <!-- 彩色日志 --> <!-- 配置格式變量:CONSOLE_LOG_PATTERN 彩色日志格式 --> <!-- magenta:洋紅 --> <!-- boldMagenta:粗紅--> <!-- cyan:青色 --> <!-- white:白色 --> <!-- magenta:洋紅 --> <property name="CONSOLE_LOG_PATTERN" value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%cyan(%msg%n)"/> <!--輸出到控制臺--> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <!--此日志appender是為開發(fā)使用,只配置最底級別,控制臺輸出的日志級別是大于或等于此級別的日志信息--> <!-- 例如:如果此處配置了INFO級別,則后面其他位置即使配置了DEBUG級別的日志,也不會被輸出 --> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>INFO</level> </filter> <encoder> <Pattern>${CONSOLE_LOG_PATTERN}</Pattern> <!-- 設置字符集 --> <charset>UTF-8</charset> </encoder> </appender> <!--輸出到文件--> <!-- 時間滾動輸出 level為 INFO 日志 --> <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在記錄的日志文件的路徑及文件名 --> <file>${log.path}/log_info.log</file> <!--日志文件輸出格式--> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> </encoder> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 每天日志歸檔路徑以及格式 --> <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天數(shù)--> <maxHistory>15</maxHistory> </rollingPolicy> <!-- 此日志文件只記錄info級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 時間滾動輸出 level為 WARN 日志 --> <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在記錄的日志文件的路徑及文件名 --> <file>${log.path}/log_warn.log</file> <!--日志文件輸出格式--> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> <!-- 此處設置字符集 --> </encoder> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天數(shù)--> <maxHistory>15</maxHistory> </rollingPolicy> <!-- 此日志文件只記錄warn級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>warn</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 時間滾動輸出 level為 ERROR 日志 --> <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在記錄的日志文件的路徑及文件名 --> <file>${log.path}/log_error.log</file> <!--日志文件輸出格式--> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> <!-- 此處設置字符集 --> </encoder> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天數(shù)--> <maxHistory>15</maxHistory> </rollingPolicy> <!-- 此日志文件只記錄ERROR級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>ERROR</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- <logger>用來設置某一個包或者具體的某一個類的日志打印級別、以及指定<appender>。 <logger>僅有一個name屬性, 一個可選的level和一個可選的addtivity屬性。 name:用來指定受此logger約束的某一個包或者具體的某一個類。 level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF, 如果未設置此屬性,那么當前l(fā)ogger將會繼承上級的級別。 --> <!-- 使用mybatis的時候,sql語句是debug下才會打印,而這里我們只配置了info,所以想要查看sql語句的話,有以下兩種操作: 第一種把<root level="INFO">改成<root level="DEBUG">這樣就會打印sql,不過這樣日志那邊會出現(xiàn)很多其他消息 第二種就是單獨給mapper下目錄配置DEBUG模式,代碼如下,這樣配置sql語句會打印,其他還是正常DEBUG級別: --> <!--開發(fā)環(huán)境:打印控制臺--> <springProfile name="dev"> <!--可以輸出項目中的debug日志,包括mybatis的sql日志--> <logger name="com.guli" level="INFO"/> <!-- root節(jié)點是必選節(jié)點,用來指定最基礎的日志輸出級別,只有一個level屬性 level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,默認是DEBUG 可以包含零個或多個appender元素。 --> <root level="INFO"> <appender-ref ref="CONSOLE"/> <appender-ref ref="INFO_FILE"/> <appender-ref ref="WARN_FILE"/> <appender-ref ref="ERROR_FILE"/> </root> </springProfile> <!--生產環(huán)境:輸出到文件--> <springProfile name="pro"> <root level="INFO"> <appender-ref ref="CONSOLE"/> <appender-ref ref="DEBUG_FILE"/> <appender-ref ref="INFO_FILE"/> <appender-ref ref="ERROR_FILE"/> <appender-ref ref="WARN_FILE"/> </root> </springProfile> </configuration>
以上就是實戰(zhàn)分布式醫(yī)療掛號通用模塊統(tǒng)一返回結果異常日志處理的詳細內容,更多關于分布式醫(yī)療掛號統(tǒng)一返回結果異常日志處理的資料請關注腳本之家其它相關文章!
- 分布式醫(yī)療掛號系統(tǒng)SpringCache與Redis為數(shù)據(jù)字典添加緩存
- 分布式醫(yī)療掛號系統(tǒng)EasyExcel導入導出數(shù)據(jù)字典的使用
- 分布式開發(fā)醫(yī)療掛號系統(tǒng)數(shù)據(jù)字典模塊前后端實現(xiàn)
- 實戰(zhàn)分布式醫(yī)療掛號系統(tǒng)之整合Swagger2到通用模塊
- 實戰(zhàn)分布式醫(yī)療掛號系統(tǒng)之設置微服務接口開發(fā)模塊
- 實戰(zhàn)分布式醫(yī)療掛號系統(tǒng)之設置微服務搭建醫(yī)院模塊
- 實戰(zhàn)分布式醫(yī)療掛號系統(tǒng)開發(fā)醫(yī)院科室及排班的接口
相關文章
手把手教你在eclipse創(chuàng)建第一個java?web項目并運行
Eclipse是用來做開發(fā)的自由集成開發(fā)環(huán)境,這也是很多java程序員會使用的開發(fā)環(huán)境,所以可以使用eclipse創(chuàng)建javaweb項目,下面這篇文章主要給大家介紹了關于如何在eclipse創(chuàng)建第一個java?web項目并運行的相關資料,需要的朋友可以參考下2023-02-02springboot+thymeleaf找不到視圖的解決方案
這篇文章主要介紹了springboot+thymeleaf找不到視圖的解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-06-06logback輸出日志屏蔽quartz的debug等級日志方式
這篇文章主要介紹了logback輸出日志屏蔽quartz的debug等級日志方式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-08-08