您现在的位置是：首页 >技术杂谈 >Java-Spring注解详解网站首页技术杂谈

目录

一、@Configuration：

二、@Value：

三、@Controller、@RestController：控制器注解;

四、@Service：服务层注解

五、@Repository：

七、@PostConstruct：

九、@Primary： 

十、@Lazy：

十二、@Resource：

十三、@Async：

十五、@Inject：

十六、@Singleton：

十七、@Valid：

十八、@Valided：

@Valid -> JSR-303 规范标准

十九、@PathVariable：

二十、自定义注解：

二十一、@RequestParam：

二十二、@ControllerAdvice：

二十三、@CrossOrigin：

二十四、@Scope：

二十四、@ResponseStatus：

二十五、元注解：包括 @Retention @Target @Document @Inherited四种

二十六、@Scope：

二十七、Spring使用的注解大全和解释： 

一、@Configuration：

1.声明一个IOC容器，把所有标记了@Bean注解的类注入到IOC容器中去；与xml中配置的bean意思一样；程序启动就执行；

2.程序中 用@AutoWired 或 @Resource 注解 取得用@Bean注解的bean

二、@Value：

        1.从配置文件读取值的用法，也就是从application.yaml文件中获取值，即使给变量赋了初值也会以配置文件的值为准。

        2.非静态字段：直接在字段头 添加@Value(${配置的名称})

        3.静态字段：通过 实例的构造函数new出来的实例对象访问 或者 通过new一个实例对象访问实例的方法得到实例的字段；

三、@Controller、@RestController：控制器注解;

四、@Service：服务层注解

五、@Repository：

        1.是标记数据访问层的组件，用来注解接口的，被spring扫描并注入到ioc容器；

        2.修饰哪个类表明这个类具有对数据库CRUD的功能，用在持久层的接口上

        3.需要配合使用MapperScannerConfigurer或者@MapperScan注解。

        4.与@Mapper 作用一致，二者取其一 或者 共用；

        6.@Repository是spring的注解，@Mapper是mybatis的注解

        7.这样可以直接在sercive类中，使用@Autowired注解，在创建一个私有的接口类对象，访问接口的实现类；

        8.Mapper：注解是由Mybatis框架中定义的一个描述数据层接口的注解，配置 mapper.xml文件使用，查询数据库获得数据；在启动类上添加注解，如果 每个接口都要变成实现类，只需要在启动类添加@MapperScan("接口的路径地址")

六、@Component：

        1.定义Spring管理Bean（也就是将标注@Component注解的类交由spring管理）,然后用@Autowired取出spring容器（创建一个私有的实例对象）；

七、@PostConstruct：

        1.实现Bean初始化之前的自定义操作；该方法不能是 static；该方法可以是 final；

        2.只有一个非静态方法能使用此注解

        3.被注解的方法不得有任何参数,被注解的方法返回值必须为void,被注解方法不得抛出已检查异常

        4.此方法只会被执行一次

        5.执行流程：开始 -> Web容器加载Servlet -> Servlet构造函数 -> PostConstruct注解 -> Init() -> Service -> destory() -> PreDestory()注解 -> 结束

        6.执行顺序在 过滤器(filter)后面

        7.执行顺序：构造方法 > @Autowired > @PostConstruct

        8.此注解时会影响到服务的启动时间。服务器在启动时会扫描WEB-INF/classes的所有文件和WEB-INF/lib下的所有jar包，并且可能需要与数据库交互来获取数据，然后放到缓存中。所以具体使用需要视业务场景而定

//创建一个 PostConstruct的初始化类
@Component
public class PostConstructInit {
    public static String strLoad;

    @PostConstruct
    public void initLoad() {
        strLoad = "初始化环境----frist-----success--";
        System.out.println("初始化环境----frist-----success--");
    }

    @PreDestroy
    public void loadEnd(){
        System.out.println("结束初始化环境----end-----success--");
    }
}


//controller -执行
public class TestDemo(){
    @Autowired
    private PostConstructInit postConstructInit;

    @RequestMapping("/test")
    public String test() {
        //调用@PostConstruct 的方法，加载程序初始化是的数据，如字典数据，或者缓存数据
        String strLoad = postConstructInit.strLoad;
        return strLoad;
    }
}

八、@PreDestroy：

        1.实现Bean销毁之前的自定义操作;

        2.被@PreDestroy修饰的方法会在服务器卸载Servlet的时候运行，并且只会被服务器调用一次，类似于Servlet的destroy()方法。

        3.被@PreDestroy修饰的方法会在destroy()方法之后运行，在Servlet被彻底卸载之前

九、@Primary： 

        1.自动装配时当出现多个Bean候选者时，被注解为@Primary的Bean将作为首选者，否则将抛出异常

	//第一个类
    public interface Worker {
	    public String work();
	}
	
    //第二个类
	@Component
	public class Singer implements Worker {
	    @Override
	    public String work() {
	        return "歌手的工作是唱歌";
	    }
	}
	
    //第三个类
	@Component
    @Primary
	public class Doctor implements Worker {
	    @Override
	    public String work() {
	        return "医生工作是治病";
	    }
	}
	
	// 启动类，调用接口
	@SpringBootApplication
	@RestController
	public class SimpleWebTestApplication {
	
	    @Autowired
	    private Worker worker;
	
	    @RequestMapping("/info")
	    public String getInfo(){
	        return worker.work();//输出 医生工作是治病
	    }
	
	    public static void main(String[] args) {
	        SpringApplication.run(SimpleWebTestApplication.class, args);
	    }
	
	}

十、@Lazy：

        1.用于指定该Bean是否取消预初始化，用于注解类，延迟初始化

        2.只不过是给spring的代理对象proxy再进行了一次proxy;

        3.借用了方法invoke时通过proxy的intercept方法getTarget，然后进行方法调用，延迟了对象的注入。之后每次调用的时候都需要从Spring容器中获取到原生的proxy对象

        4.主要解决 循环依赖 报错问题

@Lazy // 延迟加载 A
@Service
public class A {
    @Autowired
    private B b;

    @Async
    public void m1() {
    }
}

@Service
public class B {
    @Autowired
    @Lazy // 延迟注入 A
    private A a;
}

十一、@Autowired：

        1.实现spring的依赖注入，自动装配，默认凭据类型注入；

        2.Spring 框架提供的注解，它可以自动装配一个 Bean，可以根据类型进行匹配，也可以根据名称进行匹配。当有多个 Bean 可以匹配时，可以使用 @Qualifier 注解指定具体的 Bean

十二、@Resource：

        1.用于依赖注入的注解， 默认根据名称装配；

        2.Java EE 提供的注解，它也可以自动装配一个 Bean，但是它只能根据名称进行匹配。如果没有指定名称，则默认使用属性名作为 Bean 的名称进行匹配。

十三、@Async：

        1.是一个异步方法；适用于异步场景，如：发邮件，导数据，同步商品等等；

        2.主启动类没有添加@EnableAsync注解

        3.被 @Async注解 修饰的方法必须不可以是static和private，必须为public

        4.需要通过 @Autowired 或 @Resource 进行注入，不可手动new

        5.被调用的@Async注解修饰的B方法，与调用者A不能存在同一个类，否则的话A方法就没有走spring代理类，没有经过Spring容器托管，从而造成了注解的失效；

@Async：异步方法
@RestController
public class UserController {

    @Resource
    private UserService userService;

    @RequestMapping("/getAll")
    public String getUsers() throws ExecutionException, InterruptedException {
        System.out.println("业务开始");
        Future<String> result = userService.getUsers();
        System.out.println("业务结束");
        return result.get();
    }

}

@Service
public class UserService {

    @Async
    public Future<String> getUsers(){
        try {
            Thread.sleep(2000);
            System.out.println(Thread.currentThread().getName()+"查询到了所有的用户信息！");
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
        return new AsyncResult<>("异步任务执行好了");
    }

}

@SpringBootApplication
@EnableAsync
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

十四、@Named：

        1.定义Spring管理Bean（也就是将标注@Component注解的类交由spring管理）,然后用@Autowired取出spring容器（创建一个私有的实例对象）；

        2.用法 和 @Component 一致；

十五、@Inject：

        1.实现Java EE CDI方式的依赖注入。

        2.跟 @Autowired 功能一样

十六、@Singleton：

        1.只要在类上加上这个注解，就可以实现一个单例类，不需要自己手动编写单例实现类。

十七、@Valid：

        1.用来校验接收参数的

        2.使用 Hibernate validation 的时候使用，是 JSR-303 规范标准注解支持

        3.可以用在方法、构造函数、方法参数和成员属性（field）上；

        4.没有分组的功能，不能进行分组校验

        5.可以进行嵌套校验，但是，需要在嵌套的字段上面加上注解；

        6.valid  ->  级联校验 也叫嵌套检测： 

//valid  ->  级联校验 也叫嵌套检测

@Data
public class Hair {
	
	@NotBlank(message = "头发长度必须提交！")
	private Double length;

  	@NotBlank(message = "头发颜色必须提交！")
  	private String color;
}

@Data
public class Person {
	
	@NotBlank(message = "用户姓名必须提交！")
	@Size(min=2, max=8)
	private String userName;

  	// 添加@Valid注解实现嵌套检测
  	@Valid
    @NotEmpty(message = "用户要有头发！")
    private List<Hair> hairs;
}
 
@PostMapping("/person")
public Result addPerson(@Valid @RequestBody Person person) {
	return Result.buildSuccess(person);
}

十八、@Valided：

        1.用来校验接收参数的

        2.是spring校验机制；

        3.可以用在类型、方法和方法参数上，不能用于成员属性（field）上

        4.提供分组功能，可以在参数验证时，根据不同的分组采用不同的验证机制

        5.不能进行嵌套对象校验；

        6.分组校验顺序通过使用 @GroupSequence注解实现

        7.Validated ->  分组校验：  

//Validated-> 自定义分组校验

@RestController
@RequestMapping("/person")
public class PersonGroupController {
	
	// 不指定分组时校验
	@GetMapping("/person")
	public Result getPerson(@Validated @RequestBody PersonGroup person) {
		return Result.buildSuccess(person);
	}

	// 指定AddGroup分组校验
	@PostMapping("/person")
	public Result addPerson(@Validated(value = PersonGroup.AddGroup.class) @RequestBody PersonGroup person) {
		return Result.buildSuccess(person);
	}

	// 指定UpdateGroup分组校验
	@PutMapping("/person")
	public Result updatePerson(@Validated(value = PersonGroup.updateGroup.class) @RequestBody PersonGroup person) {
		return Result.buildSuccess(person);
	}
 
    // 使用GroupSequence定义分组校验顺序：按照FirstGroup，SecondGroup分组顺序进行校验
    @GroupSequence({PersonGroup.class, updateGroup.class})
    public interface Group {}
}

十九、@PathVariable：

        1.用来指定请求URL中的变量

// 请求路径中的id必须是数字，否则寻找不到这个路径404
@GetMapping("/user/{id:\d+}")
public Result getId(@PathVariable(name="id") String userId) {
	return Result.buildSuccess(userId);
}

二十、自定义注解：

        1.自定义校验注解类需要实现ConstraintValidator<A extends Annotation, T> 接口：

                2.1.接口中第一个泛型参数表示的是自定义注解类

                2.2.接口中第二个泛型参数表示的是校验的属性的值的类型

        2.依赖 @Constraint 来 （自定义注解） 自定义注解以便进行对象属性的校验

一、自定义Xss校验注解
@Retention(RetentionPolicy.RUNTIME)
@Target(value = { ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.PARAMETER })
@Constraint(validatedBy = { XssValidator.class })
public @interface Xss
{
    String message()

    default "不允许任何脚本运行";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}


二、校验器
public class XssValidator implements ConstraintValidator<Xss, String>
{
    private final String HTML_PATTERN = "<(\S*?)[^>]*>.*?|<.*? />";

    @Override
    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext)
    {
        return !containsHtml(value);
    }

    public boolean containsHtml(String value)
    {
        Pattern pattern = Pattern.compile(HTML_PATTERN);
        Matcher matcher = pattern.matcher(value);
        return matcher.matches();
    }
}

二十一、@RequestParam：

        1.作用是提取和解析请求中的参数。

        2.@RequestParam支持类型转换，类型转换目前支持所有的基本Java类型

        3.使用方法：@RequestParam([value="number"], [required=false]) String number

二十二、@ControllerAdvice：

        1.注解只能处理进入控制器方法抛出的异常

二十三、@CrossOrigin：

1.注解：是Cross-Origin ResourceSharing(跨域资源共享)

@CrossOrigin
 public class TestController extends BaseController {
     .......
 }

二十四、@Scope：

        1.配置bean的作用域。默认是单例模式，即@Scope("singleton")

二十四、@ResponseStatus：

        1.用于修饰一个类或者一个方法，修饰一个类的时候，一般修饰的是一个异常类,当处理器的方法被调用时，返回 指定的code和reason会被返回给前端。value属性是http状态码，比如404，500等。reason是错误信息

@ResponseStatus(value=HttpStatus.FORBIDDEN, reason="出现了错误")
 public class UserException extends RuntimeException{
     ......
 }


@ControllerAdvice
 @Component
 public class GlobalExceptionHandler {
     @Bean
     public MethodValidationPostProcessor methodValidationPostProcessor() {
         return new MethodValidationPostProcessor();
     }
 @ExceptionHandler
 @ResponseBody
 @ResponseStatus(value=HttpStatus.BAD_REQUEST,reason="哈哈")
 public String handle(ValidationException exception) {
     System.out.println("bad request, " + exception.getMessage());
     return "bad request, " + exception.getMessage();
 }
 }

        2.上面代码方法得到调用，不论是否抛异常，都会把value和reason添加到response里

二十五、元注解：包括 @Retention @Target @Document @Inherited四种

        1.元注解是指注解的注解，比如我们看到的ControllerAdvice注解定义如下：

@Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 @Component
 public @interface ControllerAdvice {
     XXX
 }

@Retention: 定义注解的保留策略：

@Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中，在class字节码文件中不包含

@Retention(RetentionPolicy.CLASS) //默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，

@Retention(RetentionPolicy.RUNTIME) //注解会在class字节码文件中存在，在运行时可以通过反射获取到

@Target：定义注解的作用目标:

@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) ///包

@Document：说明该注解将被包含在javadoc中

@Inherited：说明子类可以继承父类中的该注解

二十六、@Scope：

        1.配置bean的作用域。默认是单例模式，即@Scope("singleton")

二十七、Spring使用的注解大全和解释：