SpringBoot自定義註解開發指南
一、Java註解(Annotation)
含義：Java註解是附加在代碼中的一些元信息，用於一些工具在編譯、 運行時進行解析和使用，起到說明、配置的功能。
1、JDK基本註解
@Override ——》重寫
@Deprecated ——》已過時
@SuppressWarnings(value = "unchecked") ——》壓制編輯器警告
2、JDK元註解
含義：元註解用於修飾其他的註解(紀委：管幹部的幹部)
①、@Retention ——》定義註解的保留策略
@Retention(RetentionPolicy.SOURCE) //註解僅存在於源碼中，在class字節碼文件中不包含
@Retention(RetentionPolicy.CLASS)//默認的保留策略，註解會在class字節碼文件中存在，但運行時無法獲得，
@Retention(RetentionPolicy.RUNTIME)//註解會在class字節碼文件中存在，在運行時可以通過反射獲取到
②、@Target ——》指定被修飾的Annotation可以放置的位置(被修飾的目標)
@Target(ElementType.TYPE) ——》接口、類
@Target(ElementType.FIELD) ——》屬性
@Target(ElementType.METHOD) ——》方法
@Target(ElementType.PARAMETER) ——》方法參數
@Target(ElementType.CONSTRUCTOR) ——》構造函數
@Target(ElementType.LOCAL_VARIABLE) ——》局部變量
@Target(ElementType.ANNOTATION_TYPE) ——》註解
@Target(ElementType.PACKAGE) ——》包
註：可以指定多個位置，如：
@Target({ElementType.METHOD, ElementType.TYPE})，也就是此註解可以在方法和類上面使用
③、@Inherited：指定被修飾的Annotation將具有繼承性
④、@Documented：指定被修飾的該Annotation可以被javadoc工具提取成文檔.
二、自定義註解開發
1、含義
使用@interface關鍵字, 其定義過程與定義接口非常類似, 需要註意的是:
Annotation的成員變量在Annotation定義中是以無參的方法形式來聲明的, 其方法名和返回值類型定義瞭該成員變量的名字和類型, 而且我們還可以使用default關鍵字為這個成員變量設定默認值
2、演示
①、枚舉類：enum，指的是常量的集合
②、註解類
Ⅰ、演示@Retention(RetentionPolicy.SOURCE)註解：MyAnnotation.java
package com.lv.annotation;
import org.springframework.beans.factory.annotation.Autowired;
import java.lang.annotation.*;
/**
* @author T440s
*/
//生成一個註釋
@Documented
//表示當前註解可以打在什麼東西上面,此處可以放在類上與方法上
@Target({ElementType.TYPE,ElementType.METHOD})
//指定被修飾的Annotation將具有繼承性
@Inherited
//註解僅存在於源碼中，在class字節碼文件中不包含
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation {
String value() default "";
}
TestController.java:註意這引用瞭MyAnnotation註解
package com.lv.controller;
import com.lv.annotation.MyAnnotation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
@MyAnnotation
@Controller
public class TestController {
@Autowired
private String name;
@MyAnnotation
public void aa(){
}
}
運行後target層註解消失：註解僅存在於源碼中，在class字節碼文件中不包含
Ⅱ、MyAnnotation註解為@Retention(RetentionPolicy.RUNTIME)時
——註解會在class字節碼文件中存在，在運行時可以通過反射獲取到
運行test.java:
package com.lv.controller;
import java.lang.annotation.Annotation;
public class Test {
public static void main(String[] args) {
// 反射
for(Annotation a:TestController.class.getAnnotations()){
System.out.println(a);
}
}
}
Ⅲ、取註解裡的屬性值
註解：MyAnnotation.java
String message() default "aaa";
拿值：
package com.lv.controller;
import com.lv.annotation.MyAnnotation;
import java.lang.annotation.Annotation;
public class Test {
public static void main(String[] args) {
// 反射
for(Annotation a:TestController.class.getAnnotations()){
if(a instanceof MyAnnotation){
System.out.println(((MyAnnotation) a).message());
}
}
}
}
Ⅳ、判斷在該類有無該註解
測試：
package com.lv.controller;
import com.lv.annotation.MyAnnotation;
import java.lang.annotation.Annotation;
public class Test {
public static void main(String[] args) {
// 直接將MyAnnotation這註解取出
MyAnnotation myAnnotation=TestController.class.getAnnotation(MyAnnotation.class);
if(myAnnotation !=null){
System.out.println(myAnnotation.message());
}
}
}
三、完成切面日志操作
當我們在寫增刪改的時候，會有很多冗餘的代碼，後期修改很麻煩，如：
@RequestMapping("/add")
public String add(){
System.out.println("xxx在增加");
System.out.println("增加成功");
return "yes";
}
我們就可以定義aop面向切面，將前面那部分放入前置通知，後面一部分後置通知
新建切面：LogAop.java
package com.lv.aop;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
@Aspect
//類不被識別，將類變成一個組件
@Component
@Slf4j
public class LogAop {
// 指定切入的規則,".."代表可有參可無參
@Pointcut("execution(* com.lv.controller.*Controller.*(..))")
public void logger(){}
// 環繞通知
@Around("logger()")
public Object around(ProceedingJoinPoint point){
// 獲得方法名稱
Signature methodName=point.getSignature();
// 日志輸出
log.info(methodName+"進來瞭");
Long l1=System.currentTimeMillis();
// 讓方法執行
Object obj=null;
try {
obj=point.proceed(point.getArgs());
} catch (Throwable throwable) {
throwable.printStackTrace();
}
log.info(methodName+"走瞭"+"\t耗時"+(System.currentTimeMillis()-l1));
return obj;
}
}
使用jrebel運行：
package com.lv.controller;
import com.lv.annotation.MyAnnotation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@MyAnnotation
//直接返回json數據
@RestController
//返回頁面跳轉數據
//@Controller
public class TestController {
@RequestMapping("/add")
public String add(){
return "yes";
}
@RequestMapping("/del")
public String del(){
return "yes";
}
@RequestMapping("/upd")
public String upd(){
return "yes";
}
@RequestMapping("/list")
public String list(){
return "yes";
}
}
使用註解來開發aop日志：
新建註解類：MyLog.java
package com.lv.annotation;
import java.lang.annotation.*;
@Inherited
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
}
同樣在切面類中，記得改變切入的規則
@Pointcut("@annotation(com.lv.annotation.MyLog)")
需要輸出日志的方法就將新建的註解加上
四、完成前端響應反應
傳入四個文件：
ResponseParse.java:
package com.lv.response;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
/**
* @author hgh
*/
//響應增強類
@RestControllerAdvice
public class ResponseParse implements ResponseBodyAdvice {
@Override
public boolean supports(MethodParameter methodParameter, Class aClass) {
//返回值決定他是否需要進入beforeBodyWrite
return methodParameter.getMethod().isAnnotationPresent(ResponseResult.class);
}
@Override
public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
//更改返回值
if (o == null) {
return Result.success();
}
if (o instanceof Integer) {
return Result.failure(ResultCode.queryCode((Integer) o));
}
if (o instanceof ResultCode) {
return Result.failure((ResultCode) o);
}
if (o instanceof Result) {
return o;
}
return null;
}
}
ResponseResult.java:
package com.lv.response;
import java.lang.annotation.*;
/**
* @author hgh
*/
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
@Target({ElementType.METHOD})
public @interface ResponseResult {
}
Result.java:
package com.lv.response;
import lombok.Data;
import java.io.Serializable;
/**
* 響應對象封裝類
*
* @author hgh
*/
@Data
public class Result<T> implements Serializable {
private final int code;
private final String message;
private final T data;
/**
* 私有構造, 隻允許通過static調用構造
*
* @param resultCode 結果枚舉
* @param data 響應數據
*/
private Result(ResultCode resultCode, T data) {
this.code = resultCode.getCode();
this.message = resultCode.getMessage();
this.data = data;
}
/**
* 成功調用返回的結果(無數據攜帶)
*
* @return Result
*/
public static Result success() {
return success(null);
}
/**
* 成功調用返回的結果(數據攜帶)
*
* @return Result
*/
public static <T> Result success(T data) {
return new Result(ResultCode.SUCCESS, data);
}
/**
* 失敗調用返回的結果(數據攜帶)
*
* @param resultCode 狀態枚舉
* @param data 攜帶的數據
* @return Result
*/
public static <T> Result failure(ResultCode resultCode, T data) {
return new Result(resultCode, data);
}
/**
* 失敗調用返回的結果(無數據攜帶)
*
* @param resultCode 狀態枚舉
* @return Result
*/
public static Result failure(ResultCode resultCode) {
return failure(resultCode, null);
}
}
ResultCode.java:
package com.lv.response;
import java.io.Serializable;
/**
* 響應結果碼枚舉
*
* @author hgh
*/
public enum ResultCode implements Serializable {
/* 正常狀態 */
SUCCESS(100, "成功"),
FAILURE(101, "失敗"),
UNKNOWN(102, "未知響應"),
/**
* 用戶code范圍: 200~300;
*/
USER_ACCOUNT_NOT_FIND(201, "用戶名不存在"),
USER_ACCOUNT_DISABLED(202, "該用戶已被禁用"),
USER_PASSWORD_NOT_MATCH(203, "該用戶密碼不一致"),
USER_PERMISSION_ERROR(204, "該用戶不具備訪問權限"),
USER_STATE_OFF_LINE(205, "該用戶未登錄");
private final Integer code;
private final String message;
ResultCode(Integer code, String message) {
this.code = code;
this.message = message;
}
public Integer getCode() {
return code;
}
public String getMessage() {
return message;
}
public static ResultCode queryCode(Integer code) {
for (ResultCode value : values()) {
if (code.equals(value.code)) {
return value;
}
}
return UNKNOWN;
}
}
測試：
package com.lv.controller;
import com.lv.annotation.MyAnnotation;
import com.lv.annotation.MyLog;
import com.lv.response.ResponseResult;
import com.lv.response.Result;
import com.lv.response.ResultCode;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@MyAnnotation
//直接返回json數據
@RestController
//返回頁面跳轉數據
//@Controller
public class TestController {
@MyLog
@ResponseResult
@RequestMapping("/add")
public Result add(){
return Result.success("yes");
}
@RequestMapping("/del")
@ResponseResult
public Object del(){
return 201;
}
@RequestMapping("/upd")
@ResponseResult
public Object upd(){
return ResultCode.USER_ACCOUNT_NOT_FIND;
}
@RequestMapping("/list")
@ResponseResult
public Object list(){
return Result.success("yes");
}
}
增加：
刪除：
總結
到此這篇關於SpringBoot自定義註解的文章就介紹到這瞭,更多相關SpringBoot自定義註解內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！
推薦閱讀：
- SpringBoot中註解@AliasFor的使用詳解
- 詳解java註解相關知識
- 基於註解實現 SpringBoot 接口防刷的方法
- SpringBoot 統一公共返回類的實現
- SpringBoot中如何統一接口返回與全局異常處理詳解