JAVAJava基础

Java原生注解和Spring注解的说明

2019-09-16  本文已影响0人  花神子

注解

一 Java原生注解

Java注解是在JDK1.5以后引入的新特性！

目前为止JDK自带的原生注解有6个：@Retention , @Target , @Inherited , @Documented , @Repeatable , @Native
其中，@Native、@Repeabable是在JDK1.8之后推出的元注解！

注解1 @Retention

@Retention表示注解保留周期，用于提示注解被保留多长时间，

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();
}

有三种取值：

public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     *
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

注解2 @Target

@Target: 表示注解可以使用在什么地方

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

常见的取值有：

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

注解3 @Documented

注解写入文档 表示注解是否能被 javadoc 处理并保留在文档中。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}

注解4 @Inherited

子类继承父类的注解（子类没有任何注解修饰）

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited {
}

注解5 @Repeatable

@Repeatable : 表示注解的属性可以重复！同一种注解多次使用。可以用来表示某个对象存在多个身份。@Repeatable通俗来讲，就是注解容器！

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Repeatable {
    /**
     * Indicates the <em>containing annotation type</em> for the
     * repeatable annotation type.
     * @return the containing annotation type
     */
    Class<? extends Annotation> value();
}

JDK提供的其他注解

@Deprecated:用于标志过时的类、方法和成员变量
@Override:用于修饰重写的方法
@SuppressWarnings:用于忽略@Deprecated标志过的警告
@SafeVarargs：参数安全类型注解，用于提示用户参数安全（JDK1.7）
@FunctionalInterface：函数式接口注解，用于定义函数式接口(JDK1.8)

范例

@Override的作用是，提示编译器，使用了@Override注解的方法必须override父类或者java.lang.Object中的一个同名方法。
表示 @Override 只能使用在方法上，保留在源码级别，被编译器处理，然后抛弃掉。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

二 Spring中的注解

注解1 @Autowired

Spring开发者对@Autowired注解必定是非常了解，其实就是 autowire=byType 就是根据类型的自动注入依赖（基于注解的依赖注入），可以被使用再属性域，方法，构造函数上。

@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Autowired {
    boolean required() default true;
}

注解2 @Qualifier

@Qualifier 就是 autowire=byName, 当@Autowired注解判断多个bean类型相同时，就需要使用 @Qualifier("xxBean") 来指定依赖的bean的id：

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Qualifier {
    String value() default "";
}

注解3 @Resource

@Resource 属于JSR250标准，它并不是Spring提供的注解，但是Spring对它提供了支持。

@Target({TYPE, FIELD, METHOD})
@Retention(RUNTIME)
public @interface Resource {

  String name() default "";
  
  String lookup() default "";
  
  Class<?> type() default java.lang.Object.class;  

  enum AuthenticationType {
    CONTAINER,
    APPLICATION 
  }
  AuthenticationType authenticationType() default AuthenticationType.CONTAINER;

  boolean shareable() default true;
}

@Resource装配顺序:

注解4 @Component @Repository, @Service, @Controller

@Component 是spring注解，注解后可以被spring框架所扫描并注入到spring容器来进行管理

@Controller, @Service, @Repository, 这几个注解不同于上面的注解，上面的注解都是将被依赖的bean注入进入，而这几个注解的作用都是生产bean, 这些注解都是注解在类上，将类注解成spring的bean工厂中一个一个的bean。@Controller, @Service, @Repository基本就是语义更加细化的@Component。

注解5 # @RequestParam @RequestBody @PathVariable

用于参数绑定的注解

范例

@RestController
@RequestMapping("/head")
public class DemoController {

    @RequestMapping("/info")
    public String headInfo(@RequestHeader("Accept-Encoding") String encoding ,@RequestHeader("Keep-Alive")long keepAlive) {
        return encoding + " : " + keepAlive;
    }
}

@RequestParam

@RequestBody
该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容，例如application/json, application/xml等；

它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body，然后绑定到相应的bean上的。

注解6 @PostConstruct 和 @PreDestroy

@PostConstruct 和 @PreDestroy 不是用于依赖注入，而是bean 的生命周期。类似于 init-method(InitializeingBean) destory-method(DisposableBean).
Spring 容器中的 Bean 是有生命周期的，Spring 允许在 Bean 在初始化完成后以及 Bean销毁前执行特定的操作，您既可以通过实现 InitializingBean/DisposableBean 接口来定制初始化之后 /销毁之前的操作方法，也可以通过 <bean> 元素的 init-method/destroy-method 属性指定初始化之后 /销毁之前调用的操作方法
容器初始化 bean 和销毁前所做的操作定义方式有三种：
第一种：通过@PostConstruct 和 @PreDestroy 方法 实现初始化后和销毁bean之前进行的操作
第二种是：通过 在xml中定义init-method 和 destory-method方法
第三种是： 通过bean实现InitializingBean和 DisposableBean接口

范例

public class Boss {
    @Resource
    private Car car;

    @Resource(name = "office")
    private Office office;

    @PostConstruct
    public void postConstruct1(){
        System.out.println("postConstruct1");
    }

    @PreDestroy
    public void preDestroy1(){
        System.out.println("preDestroy1"); 
    }
}

public class AnnoIoCTest {

    public static void main(String[] args) {
        String[] locations = {"beans.xml"};
        ClassPathXmlApplicationContext ctx = 
            new ClassPathXmlApplicationContext(locations);
        Boss boss = (Boss) ctx.getBean("boss");
        System.out.println(boss);
        ctx.destroy();// 关闭 Spring 容器，以触发 Bean 销毁方法的执行
    }
}

最后说明下Spring对注解的处理

三 spring中注解的处理

spring中注解的处理基本都是通过实现接口 BeanPostProcessor 来进行的：

public interface BeanPostProcessor {
    @Nullable default Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
         return bean; 
     }    
    @Nullable
    default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }
    
}

相关的处理类有：

AutowiredAnnotationBeanPostProcessor，
CommonAnnotationBeanPostProcessor，
PersistenceAnnotationBeanPostProcessor，
RequiredAnnotationBeanPostProcessor
...
上一篇下一篇

猜你喜欢

热点阅读