【Spring】注解（Annotation）的理解与使用

Annotation

从JDK5开始，java增加了对元数据（描述数据属性的信息）的支持。其实说白就是代码里的特殊标志，这些标志可以在编译，类加载，运行时被读取，并执行相应的处理，以便于其他工具补充信息或者进行部署。

手写注解示例

@Retention(RetentionPolicy.RUNTIME) 运行时此注解生效
@Target(ElementType.FIELD) 写在类属性上面

新建MyValue注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface MyValue {
    String value() default "";
}

新建配置jdbc.properties

jdbcUrl=jdbc:mysql://localhost:3306/test?serverTimezone=Asia/Shanghai
username=root
password=root
driverClass=com.mysql.cj.jdbc.Driver

新建类MyDS

import com.alibaba.druid.pool.DruidDataSource;
import com.myspring.day3.annotation.MyValue;

import javax.sql.DataSource;
import java.lang.reflect.Field;
import java.util.Properties;

public class MyDS {

    private static DruidDataSource ds=null;
    @MyValue("jdbcUrl")
    private static String jdbcurl;
    @MyValue("username")
    private static String username;
    @MyValue("password")
    private static String password;
    @MyValue("driverClass")
    private static String driverClass;

    public static void main(String[] args) {
        try {
           parseJdbc();
           ds=new DruidDataSource();
           ds.setUrl(jdbcurl);
           ds.setUsername(username);
           ds.setPassword(password);
           ds.setDriverClassName(driverClass);
            System.out.println(ds);
        }catch (Exception e){
            e.printStackTrace();
        }

    }

    public static void parseJdbc(){
        try {
            //1.读取配置文件
            Properties properties=new Properties();
            properties.load(MyDS.class.getClassLoader()
                      .getResourceAsStream(
                            "jdbc.properties"));
            //2.得到注解
            Field[] fields=MyDS.class.getFields();
            for(Field f:fields){
                MyValue myValue = f.getAnnotation(MyValue.class);
                if(myValue==null){
                //没有注解的属性不操作
                    continue;
                }
                String key=myValue.value();
                f.setAccessible(true);
                f.set(null,properties.getProperty(key));
            }
        }catch (Exception e){
            e.printStackTrace();
        }

    }
}

Spring注解

@Component 相当于<bean />，把类当成spring的组件，spring会创建实例存在ioc容器中
@PostConstruct 初始化方法，相当于<bean init-method="xxx" />
@PreDestroy 销毁方法，相当于<bean destroy-method="xxx" />

1.声明bean的注解

Spring注解	描述
@Component	组件，没有明确的角色
@Service	在业务逻辑层使用（service层）
@Repository	在展现层使用，控制器的声明（C）
@Controller	定义文档的主体

2.注入bean的注解

Spring注解	描述
@Autowired	Spring提供的工具（由Spring的依赖注入工具（BeanPostProcessor、BeanFactoryPostProcessor）自动注入。）
@Inject	由JSR-330提供
@Resource	由JSR-250提供

3.java配置类相关注解

Spring注解	描述
@Configuration	声明当前类为配置类，相当于xml形式的Spring配置（类上）
@Bean	注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式（方法上）
@Configuration	声明当前类为配置类，其中内部组合了@Component注解，表明这个类是一个bean（类上）
@ComponentScan	用于对Component进行扫描，相当于xml中的context:component-scan（类上）
@WishlyConfiguration	为@Configuration与@ComponentScan的组合注解，可以替代这两个注解

4.切面（AOP）相关注解

Spring注解	描述
@Aspect	声明一个切面（类上）,使用@After、@Before、@Around定义建言（advice），可直接将拦截规则（切点）作为参数。
@After	在方法执行之后执行（方法上）
@Before	在方法执行之前执行（方法上）
@Around	在方法执行之前与之后执行（方法上）
@PointCut	声明切点, 在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持（类上）

5.@Bean的属性支持

Spring注解	描述
@Scope	设置Spring容器如何新建Bean实例（方法上，得有@Bean）其设置类型包括：Singleton （单例,一个Spring容器中只有一个bean实例，默认模式）,Protetype （每次调用新建一个bean）,Request （web项目中，给每个http request新建一个bean）,Session （web项目中，给每个http session新建一个bean）,GlobalSession（每一个 global http session新建一个Bean实例）
@StepScope	在Spring Batch中还有涉及
@PostConstruct	由JSR-250提供，在构造函数执行完之后执行，等价于xml配置文件中bean的initMethod
@PreDestory	由JSR-250提供，在Bean销毁之前执行，等价于xml配置文件中bean的destroyMethod

6.@Value注解

@Value	为属性注入值（属性上）

7.环境切换

Spring注解	描述
@Profile	通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境。（类或方法上）
@Conditional	Spring4中可以使用此注解定义条件话的bean，通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。（方法上）

8.异步相关

Spring注解	描述
@EnableAsync	配置类中，通过此注解开启对异步任务的支持，叙事性AsyncConfigurer接口（类上）
@Async	在实际执行的bean方法使用该注解来申明其是一个异步任务（方法上或类上所有的方法都将异步，需要@EnableAsync开启异步任务）

9.定时任务相关

Spring注解	描述
@EnableScheduling	在配置类上使用，开启计划任务的支持（类上）
@Scheduled	来申明这是一个任务，包括cron,fixDelay,fixRate等类型（方法上，需先开启计划任务的支持）

10.@Enable*注解说明

这些注解主要用来开启对xxx的支持。

Spring注解	描述
@EnableAspectJAutoProxy	开启对AspectJ自动代理的支持
@EnableAsync	开启异步方法的支持
@EnableScheduling	开启计划任务的支持
@EnableWebMvc	开启Web MVC的配置支持
@EnableConfigurationProperties	开启对@ConfigurationProperties注解配置Bean的支持
@EnableJpaRepositories	开启对SpringData JPA Repository的支持
@EnableTransactionManagement	开启注解式事务的支持
@EnableCaching	开启注解式的缓存支持

11.测试相关注解

Spring注解	描述
@RunWith	运行器，Spring中通常用于对JUnit的支持
@ContextConfiguration	用来加载配置ApplicationContext，其中classes属性用来加载配置类

12.SpringMVC部分

上一部分的注解是Spring的注解，这一部分的注解是SpringMVC的注解

SpringMVC注解	描述
@EnableWebMvc	在配置类中开启Web MVC的配置支持，如一些ViewResolver或者MessageConverter等，若无此句，重写WebMvcConfigurerAdapter方法（用于对SpringMVC的配置）。
@Controller	声明该类为SpringMVC中的Controller
@RequestMapping	用于映射Web请求，包括访问路径和参数（类或方法上）
@ResponseBody	支持将返回值放在response内，而不是一个页面，通常用户返回json数据（返回值旁或方法上）
@RequestBody	允许request的参数在request体中，而不是在直接连接在地址后面。（放在参数前）
@PathVariable	用于接收路径参数，比如@RequestMapping(“/hello/{name}”)申明的路径，将注解放在参数中前，即可获取该值，通常作为Restful的接口实现方法。
@RestController	该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。
@ControllerAdvice	通过该注解，我们可以将对于控制器的全局配置放置在同一个位置，注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上，
@ExceptionHandler	用于全局处理控制器里的异常
@InitBinder	用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到Model中。
@ModelAttribute	本来的作用是绑定键值对到Model里，在@ControllerAdvice中是让全局的@RequestMapping都能获得在此处设置的键值对。