SpringMVC之自定义注解
自定义注解简介
SpringMVC是一个优秀的MVC框架，它提供了许多注解，如@Controller、@RequestMapping、@PathVariable等，用来简化开发者的开发工作。但是，在实际开发中，有些业务场景可能需要自定义注解来实现特定的功能。比如，我们可能需要自定义一个注解来标识某个方法需要登录才能访问，或者需要自定义一个注解来标识某个方法需要进行数据校验等等。
SpringMVC允许开发者自定义注解，并在程序中使用它们。自定义注解的语法格式和Java中定义普通接口类似，使用@interface关键字进行定义，并且自定义注解也支持注解属性的定义。自定义注解可以应用于类、方法、属性等等，使用时只需要在需要使用的地方添加自定义注解即可。在程序运行时，可以通过Java反射机制来获取自定义注解的属性值，从而实现相关的功能。
自定义注解的使用大大简化了程序的编码和维护工作，增加了程序的可读性和可维护性，是提高开发效率的重要手段之一。它可以帮助我们减少代码量、提高代码可读性、降低程序维护成本，这些都是在实际开发中非常重要的因素。同时，自定义注解还可以帮助我们更好地理解和维护程序，是在企业级开发中不可或缺的工具之一。
Java注解分类
JDK基本注解
JDK元注解
自定义注解
JDK基本注解
1. @Override：用于表明当前方法是重写了父类或者实现了接口中的方法。如果不小心写错了方法名或者参数类型，编译时会提示错误。
2. @Deprecated：用于标记某个方法或者类已经过时，告诉开发者不要再使用该方法或者类。虽然标记为过时，但是还可以继续使用。
3. @SuppressWarnings：用于抑制警告信息，可以选择性地关闭编译器对某些代码的警告提示。例如@SuppressWarnings("unchecked")，可以关闭编译器对未经检查的转换产生的警告。
4. @SafeVarargs：用于标记当前方法使用可变参数时不会出现类型不安全的问题。该注解可以解决一些泛型转型的警告问题。
5. @FunctionalInterface：用于标记某个接口是函数式接口，即只有一个抽象方法的接口。使用该注解可以帮助开发者避免不必要的错误，同时也可以让编译器进行更加优化的处理
————————————————
版权声明：本文为CSDN博主「Kissship」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/weixin_74263417/article/details/132888074
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工具提取成文档.
自定义注解的基本案例
注解分类（根据Annotation是否包含成员变量,可以把Annotation分为两类）:
标记Annotation:
没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息元数据Annotation:
包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;
如何自定义注解？
使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:
Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型,
而且我们还可以使用default关键字为这个成员变量设定默认值；
MyAnnotation1
package com.zhanghao.annotation.demo1;
import java.lang.annotation.*;
/**
* MyAnnotation1注解可以用在类、接口、属性、方法上
* 注解运行期也保留
* 不可继承
*/
@Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation1 {
String name();
}Demo1
package com.zhanghao.annotation.demo1;
/**
* @author
* @site www.javaxl.com
*
* 获取类与方法上的注解值
*/
@MyAnnotation1(name = "abc")
public class Demo1 {
@MyAnnotation1(name = "xyz")
protected Integer age;
@MyAnnotation2(model = TranscationModel.Read)
public void list() {
System.out.println("list");
}
@MyAnnotation3(models = {TranscationModel.Read, TranscationModel.Write})
public void edit() {
System.out.println("edit");
}
}Demo1Test
package com.zhanghao.annotation.demo1;
import org.junit.jupiter.api.Test;
public class Demo1Test {
@Test
public void list() throws Exception {
// 获取类上的注解
MyAnnotation1 annotation1 = Demo2.class.getAnnotation(MyAnnotation1.class);
System.out.println(annotation1.name());//abc
// 获取方法上的注解
// MyAnnotation2 myAnnotation2 = Demo1.class.getMethod("list").getAnnotation(MyAnnotation2.class);
// System.out.println(myAnnotation2.model());//Read
//
获取属性上的注解
// MyAnnotation1 myAnnotation1 = Demo2.class.getDeclaredField("age").getAnnotation(MyAnnotation1.class);
// System.out.println(myAnnotation1.name());// xyz
}
@Test
public void edit() throws Exception {
MyAnnotation3 myAnnotation3 = Demo2.class.getMethod("edit").getAnnotation(MyAnnotation3.class);
for (TranscationModel model : myAnnotation3.models()) {
System.out.println(model);//Read,Write
}
}
}开始测试
MyAnnotation2
package com.zhanghao.annotation.demo1;
import java.lang.annotation.*;
/**
* MyAnnotation2注解可以用在方法上
* 注解运行期也保留
* 不可继承
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation2 {
TranscationModel model() default TranscationModel.ReadWrite;
}Demo2
package com.zhanghao.annotation.demo2;
/**
* @author zhanghao
* @site
* @company s集团
* @create 2023-09-15-19:00
*/
public class Demo2 {
@TestAnnotation(value = "这就是value对应的值_msg1", what = "这就是what对应的值_msg1")
private static String msg1;
@TestAnnotation("这就是value对应的值1")
private static String msg2;
@TestAnnotation(value = "这就是value对应的值2")
private static String msg3;
@TestAnnotation(what = "这就是what对应的值")
private static String msg4;
}TestAnnotation
package com.zhanghao.annotation.demo2;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author zhanghao
* @site
* @company s集团
* @create 2023-09-15-19:00
*/
//@Retention(RetentionPolicy.SOURCE)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface TestAnnotation {
String value() default "默认value值";
String what() default "这里是默认的what属性对应的值";
}Demo2Test
package com.zhanghao.annotation.demo2;
import org.junit.Test;
/**
* @author zhanghao
* @site
* @company s集团
* @create 2023-09-14-19:00
*/
public class Demo2Test {
@Test
public void test1() throws Exception {
TestAnnotation msg1 = Demo2.class.getDeclaredField("msg1").getAnnotation(TestAnnotation.class);
System.out.println(msg1.value());
System.out.println(msg1.what());
}
@Test
public void test2() throws Exception{
TestAnnotation msg2 = Demo2.class.getDeclaredField("msg2").getAnnotation(TestAnnotation.class);
System.out.println(msg2.value());
System.out.println(msg2.what());
}
@Test
public void test3() throws Exception{
TestAnnotation msg3 = Demo2.class.getDeclaredField("msg3").getAnnotation(TestAnnotation.class);
System.out.println(msg3.value());
System.out.println(msg3.what());
}
@Test
public void test4() throws Exception{
TestAnnotation msg4 = Demo2.class.getDeclaredField("msg4").getAnnotation(TestAnnotation.class);
System.out.println(msg4.value());
System.out.println(msg4.what());
}
}
MyAnnotation3
package com.zhanghao.annotation.demo1;
import java.lang.annotation.*;
/**
* @author
* @site www.javaxl.com
*
* MyAnnotation3注解可以用在方法上
* 注解运行期也保留
* 可继承
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation3 {
TranscationModel[] models() default TranscationModel.ReadWrite;
}TranscationModel
package com.zhanghao.annotation.demo1;
public enum TranscationModel {
Read, Write, ReadWrite;
private String name;
private Integer id;
public void init1(){
Read.id = 1;
Read.name = "sz";
}
public void init2(){
Write.id = 2;
Write.name = "sg";
}
public void init3(){
ReadWrite.id = 3;
ReadWrite.name = "sn";
}
}Demo3
package com.zhanghao.annotation.demo3;
/**
* @author
* @site www.javaxl.com
*
* 获取参数修饰注解对应的属性值
*/
public class Demo3 {
public void hello1(@IsNotNull(true) String name) {
System.out.println("hello:" + name);
}
public void hello2(@IsNotNull String name) {
System.out.println("hello:" + name);
}
}
AOP（面向切面编程）是一种编程范式，它允许我们在程序的不同层次上分离关注点，并将其集中到一个地方。在AOP中，我们可以通过使用注解来声明横切关注点（Cross-cutting concerns），并将其与其他代码分离出来。
自定义注解是定义在Java程序中的一种特殊类型的注解。它允许我们在Java代码中使用自定义注解来标记代码的某些信息。自定义注解可以用来指定某些代码需要经过AOP处理。
下面是一个自定义注解的示例：
@Target(ElementType.METHOD) // 该注解只能用于方法上
@Retention(RetentionPolicy.RUNTIME) // 该注解会在运行时保留
public @interface Loggable {
String value(); // 注解参数
}
在上面的示例中，我们定义了一个名为Loggable的注解，它用于标记那些需要被记录日志的方法。注解参数value()用于指定日志的内容。
使用自定义注解可以让我们在程序中标记出需要进行AOP处理的代码，使得我们可以更加方便地管理程序的关注点，并将其集中到一个地方。
今天的分享就到这啦，感谢观看谢谢！