SpringBoot詳解系列文章：
SpringBoot詳解（一）-快速入門
SpringBoot詳解（二）-Spring Boot的核心
SpringBoot詳解（三）-Spring Boot的web開發(fā)
SpringBoot詳解（四）-優(yōu)雅地處理日志
一啄刹、簡介
日志功能在j2ee項目中是一個相當常見的功能刻盐，在一個小項目中或許你可以在一個個方法中浪讳，使用日志表的Mapper生成一條條的日志記錄滚躯，但這無非是最爛的做法之一孵构，因為這種做法會讓日志Mapper分布到了項目的多處代碼中姆打，后續(xù)很難管理亭病。而對于大型的項目而言逻恐，這種做法根本不能采用因悲。本篇文章將介紹堕汞，使用自定義注解，配合AOP晃琳，優(yōu)雅的完成日志功能讯检。
本文Demo使用的是Spring Boot框架琐鲁，但并非只針對Spring Boot，如果你的項目用的是Spring MVC人灼，做下簡單的轉換即可在你的項目中實現相同的功能围段。
二、日志管理的實現
在開始編碼之前投放，先介紹下思路：
在Service層中奈泪，涉及到大量業(yè)務邏輯操作，我們往往就需要在一個業(yè)務操作完成后（不管成敗或失斁姆肌）涝桅，生成一條日志，并插入到數據庫中烙样。那么我們可以在這些涉及到業(yè)務操作的方法上使用一個自定義注解進行標記冯遂，同時將日志記錄到注解中。再配合Spring的AOP功能谒获，在監(jiān)聽到該方法執(zhí)行之后蛤肌，獲取到注解內的日志信息，把這條日志插入到數據即可批狱。
好了寻定，下面就對上面的理論付出實踐。
1精耐、自定義注解
這里我們自定義一個日志注解，該注解中的logStr屬性將用來保存日志信息琅锻。自定義注解代碼如下：
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Inherited
@Documented
public @interface Log {
String logStr() default "";
}
2卦停、使用自定義注解
接著就是到Service層中，在需要使用到日志功能的方法上加上該注解恼蓬。如果業(yè)務需求是在添加一個用戶之后惊完，記錄一條日志，那只需要在添加用戶的方法上加上這個自定義注解即可处硬。代碼如下：
@Service
public class UserService {
@Log(logStr = "添加一個用戶")
public Result add(User user) {
return ResultUtils.success();
}
}
3小槐、使用AOP統(tǒng)一處理日志
前面的自定義注解只是起到一個標記與存儲日志的作用，接下來需要就該使用Spring的AOP功能荷辕，攔截方法的執(zhí)行凿跳，通過反射獲取到注解及注解中所包含的日志信息。
如果你不清楚怎么在Spring Boot中使用AOP功能疮方，建議你去看上一篇文章：SpringBoot詳解（三）-Spring Boot的web開發(fā)控嗜，這里不再贅訴。
因為代碼量不大骡显，就不多廢話了疆栏，直接貼出日志切面的完整代碼曾掂，詳細情況看代碼中的注釋：
@Component
@Aspect
public class LogAspect {
private Logger logger = LoggerFactory.getLogger(LogAspect.class);
// 設置切點表達式
@Pointcut("execution(* com.lqr.service..*(..))")
private void pointcut() {
}
// 方法后置切面
@After(value = "pointcut()")
public void After(JoinPoint joinPoint) throws NotFoundException, ClassNotFoundException {
// 拿到切點的類名、方法名壁顶、方法參數
String className = joinPoint.getTarget().getClass().getName();
String methodName = joinPoint.getSignature().getName();
Object[] args = joinPoint.getArgs();
// 反射加載切點類珠洗，遍歷類中所有的方法
Class<?> targetClass = Class.forName(className);
Method[] methods = targetClass.getMethods();
for (Method method : methods) {
// 如果遍歷到類中的方法名與切點的方法名一致，并且參數個數也一致若专，就說明切點找到了
if (method.getName().equalsIgnoreCase(methodName)) {
Class<?>[] clazzs = method.getParameterTypes();
if (clazzs.length == args.length) {
// 獲取到切點上的注解
Log logAnnotation = method.getAnnotation(Log.class);
if (logAnnotation != null) {
// 獲取注解中的日志信息许蓖，并輸出
String logStr = logAnnotation.logStr();
logger.error("獲取日志：" + logStr);
// 數據庫記錄操作...
break;
}
}
}
}
}
}
4、驗證
為了驗證這種方式是否真的能拿到注解中攜帶的日志信息富岳，這里創(chuàng)建一個Controller蛔糯，代碼如下：
@RestController
public class UserController {
@Autowired
UserService mUserService;
@PostMapping("/add")
public Result add(User user) throws NotFoundException {
return mUserService.add(user);
}
}
使用postman訪問接口，可以看到注解中的日志信息確實被拿到了窖式。
你以為這樣就結束了嗎蚁飒？不，這僅僅只是實現了日志功能萝喘，但稱不上優(yōu)雅淮逻，因為存在不方便的地方，下面就說下阁簸，如何對這種方式進一步優(yōu)化爬早，從而做到優(yōu)雅的處理日志功能。
三启妹、優(yōu)化日志功能
1筛严、分析
前面確確實實的使用自定義注解和AOP做到了日志功能，但存在什么問題呢饶米？這個問題不是代碼問題桨啃，而是業(yè)務功能問題。開發(fā)中可能有以下幾種情況：
- 假設公司的業(yè)務是不僅僅只是記錄某個用戶使用該系統(tǒng)做了什么操作檬输，還需要記錄在操作的過程中出現過什么問題照瘾。
- 假設日志的內容，不可以在注解中寫死丧慈，要可以在代碼中自由設置日志信息析命。
簡而言之，就是日志內容可以在代碼中隨意修改逃默。這就有問題了鹃愤，注解是靜態(tài)侵入的，要怎么才能做到在代碼中動態(tài)修改注解中的屬性值呢笑旺？所幸昼浦，javassist可以幫我們做到這一點，下面就來看看筒主，如果實現該功能关噪。
javassist需要自己導入第三方依賴鸟蟹，如果你項目有使用到Spring Boot的模板功能（thymeleaf），則無須添加依賴使兔。
2建钥、完善與增強
1）封裝AnnotationUtils
結合網上查閱到的資料，我對使用javassist動態(tài)修改方法上注解及查看注解中屬性值的功能做了一個封裝虐沥，工具類名為：AnnotationUtils（和Spring自帶的一個類名字一樣熊经，注意不要在代碼中導錯包了），并使用了單例模式欲险。代碼如下：
/**
* @創(chuàng)建者 CSDN_LQR
* @描述 注解中屬性修改镐依、查看工具
*/
public class AnnotationUtils {
private static AnnotationUtils mInstance;
public AnnotationUtils() {
}
public static AnnotationUtils get() {
if (mInstance == null) {
synchronized (AnnotationUtils.class) {
if (mInstance == null) {
mInstance = new AnnotationUtils();
}
}
}
return mInstance;
}
/**
* 修改注解上的屬性值
*
* @param className 當前類名
* @param methodName 當前方法名
* @param annoName 方法上的注解名
* @param fieldName 注解中的屬性名
* @param fieldValue 注解中的屬性值
* @throws NotFoundException
*/
public void setAnnotatioinFieldValue(String className, String methodName, String annoName, String fieldName, String fieldValue) throws NotFoundException {
ClassPool classPool = ClassPool.getDefault();
CtClass ct = classPool.get(className);
CtMethod ctMethod = ct.getDeclaredMethod(methodName);
MethodInfo methodInfo = ctMethod.getMethodInfo();
ConstPool constPool = methodInfo.getConstPool();
AnnotationsAttribute attr = (AnnotationsAttribute) methodInfo.getAttribute(AnnotationsAttribute.visibleTag);
Annotation annotation = attr.getAnnotation(annoName);
if (annotation != null) {
annotation.addMemberValue(fieldName, new StringMemberValue(fieldValue, constPool));
attr.setAnnotation(annotation);
methodInfo.addAttribute(attr);
}
}
/**
* 獲取注解中的屬性值
*
* @param className 當前類名
* @param methodName 當前方法名
* @param annoName 方法上的注解名
* @param fieldName 注解中的屬性名
* @return
* @throws NotFoundException
*/
public String getAnnotatioinFieldValue(String className, String methodName, String annoName, String fieldName) throws NotFoundException {
ClassPool classPool = ClassPool.getDefault();
CtClass ct = classPool.get(className);
CtMethod ctMethod = ct.getDeclaredMethod(methodName);
MethodInfo methodInfo = ctMethod.getMethodInfo();
AnnotationsAttribute attr = (AnnotationsAttribute) methodInfo.getAttribute(AnnotationsAttribute.visibleTag);
String value = "";
if (attr != null) {
Annotation an = attr.getAnnotation(annoName);
if (an != null)
value = ((StringMemberValue) an.getMemberValue(fieldName)).getValue();
}
return value;
}
}
2）封裝LogUtils
通過上面的工具類（AnnotationUtils）雖然可以實現在代碼中動態(tài)修改注解中的屬性值的功能，但AnnotationUtils方法中需要的參數過多天试，這里對其做一層封裝槐壳，不需要在代碼中考慮類名、方法名的獲取喜每，方便開發(fā)务唐。
/**
* @創(chuàng)建者 CSDN_LQR
* @描述 日志修改工具
*/
public class LogUtils {
private static LogUtils mInstance;
private LogUtils() {
}
public static LogUtils get() {
if (mInstance == null) {
synchronized (LogUtils.class) {
if (mInstance == null) {
mInstance = new LogUtils();
}
}
}
return mInstance;
}
public void setLog(String logStr) throws NotFoundException {
String className = Thread.currentThread().getStackTrace()[2].getClassName();
String methodName = Thread.currentThread().getStackTrace()[2].getMethodName();
AnnotationUtils.get().setAnnotatioinFieldValue(className, methodName, Log.class.getName(), "logStr", logStr);
}
}
3）Service中根據情況動態(tài)修改日志信息
@Service
public class UserService {
@Log(logStr = "添加一個用戶")
public Result add(User user) throws NotFoundException {
if (user.getAge() < 18) {
LogUtils.get().setLog("添加用戶失敗，因為用戶未成年");
return ResultUtils.error("未成年不能注冊");
}
if ("男".equalsIgnoreCase(user.getSex())) {
LogUtils.get().setLog("添加用戶失敗带兜，因為用戶是個男的");
return ResultUtils.error("男性不能注冊");
}
LogUtils.get().setLog("添加用戶成功枫笛，是一個" + user.getAge() + "歲的美少女");
return ResultUtils.success();
}
}
4）修改日志切面
使用javassist修改過的注解屬性值無法通過java反射正確靜態(tài)獲取，還需要借助javassist來動態(tài)獲取刚照，所以刑巧，LogAspect中的代碼修改如下：
@Component
@Aspect
public class LogAspect {
private Logger logger = LoggerFactory.getLogger(LogAspect.class);
@Pointcut("execution(* com.lqr.service..*(..))")
private void pointcut() {
}
@After(value = "pointcut()")
public void After(JoinPoint joinPoint) throws NotFoundException, ClassNotFoundException {
String className = joinPoint.getTarget().getClass().getName();
String methodName = joinPoint.getSignature().getName();
String logStr = AnnotationUtils.get().getAnnotatioinFieldValue(className, methodName, Log.class.getName(), "logStr");
if (!StringUtils.isEmpty(logStr)) {
logger.error("獲取日志：" + logStr);
// 數據庫記錄操作...
}
}
}
3、驗證
上面代碼都編寫完了无畔，下面就驗證下海诲，是否可以根據業(yè)務情況動態(tài)注解中的屬性值吧。
