Java注解(Annotation):请不要小看我!

Java注解是一系列元数据,它提供数据用来解释程序代码,但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

网络上对注解的解释过于严肃、刻板,这并不是喜欢的风格。尽管这样的解释听起来非常的专业。

为了缓解大家对“注解”的陌生感,我来说点有意思的。其实我对“注解”这个词的第一印象并不是Java的注解,而是朱熹的名作《四书章句集注》。为什么我会有这么大的脑洞呢?因为当我试着去翻译Annotation这个单词的时候,得到的结果是“注释”而不是“注解”。《四书章句集注》正是朱熹对《大学》、《中庸》、《论语》、《孟子》四书做出的重要的注释。要知道,该书可是明清以后科举考试的题库和标准答案!

注解(Annotation)是在 Java SE 5.0 版本中开始引入的概念,同classinterface一样,也属于一种类型。很多开发人员认为注解的地位不高,但其实不是这样的。像@Transactional@Service@RestController@RequestMapping@CrossOrigin等等这些注解的使用频率越来越高。

01、为什么要使用注解呢?

为什么要使用注解呢?让我们从另外一个问题说起。

“跨域”这两个字就像一块狗皮膏药黏在每一个前端开发者的身上;我也不例外,虽然我并不是一个纯粹的前端开发者。

跨域问题的出现,源于浏览器的同源策略——限制一个源加载的脚本去访问另外一个源的资源,可有效地隔离潜在的恶意文件,是一种重要的安全机制。

跨域问题的解决方案也有很多,比如说:

1)JSONP

2)Nginx代理

3)"跨域资源共享"(Cross-origin resource sharing),简称CORS,可以说是处理跨域问题的标准做法。

记得第一次遇到跨域问题的时候,我特意向一个同学请教了解决方案,他告诉我的答案如下。

第一步,在web.xml添加filter。

<filter>  <filter-name>contextfilter</filter-name>  <filter-class>com.cmower.filter.WebContextFilter</filter-class></filter><filter-mapping>  <filter-name>contextfilter</filter-name>  <url-pattern>/*</url-pattern></filter-mapping>

第二步,实现WebContextFilter类。

public class WebContextFilter implements Filter {

    @Override    public void destroy() {    }

    @Override    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)            throws IOException, ServletException {        HttpServletResponse  httpServletResponse = (HttpServletResponse) response;        httpServletResponse.setHeader("Access-Control-Allow-Origin", "*");        httpServletResponse.setHeader("Access-Control-Allow-Headers", "accept,content-type");         httpServletResponse.setHeader("Access-Control-Allow-Methods", "OPTIONS,GET,POST,DELETE,PUT");         chain.doFilter(request, httpServletResponse);

    }

    @Override    public void init(FilterConfig arg0) throws ServletException {    }

}

看到这样的解决方案,我真的是蛮崩溃的。不就一个跨域问题嘛,用得着这么多代码吗?

我对这样的解决方案非常的不满意。于是下定决心要好好的研究一番,大概花了半天的时间吧,我终于搞清楚了“跨域”问题,以及它的标准解决方案CORS。并且找到了一个极为简洁的解决方案——@CrossOrigin,只要在Controller类上加上这个注解,就可以轻松地解决跨域问题。

代码如下。

@RestController@RequestMapping("course")@CrossOriginpublic class CourseController {}

如果没有找到@CrossOrigin这个注解,我真的就要按照同学提供的方案去解决跨域的问题了。但那样做就好像,我们卖掉家里的小汽车,然后出行的时候驾一辆马车一样。

这也正是我想告诉你的,为什么要使用注解的原因:它让我们的代码看起来更简洁,更有时代的进步感。

02、该如何定义注解呢?

注解需要通过@interface关键字(形式和接口非常的相似,只是前面多了一个@)进行定义。我们可以打开@CrossOrigin的源码来看一下。

@Target({ ElementType.METHOD, ElementType.TYPE })@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface CrossOrigin {    /**     * List of allowed origins, e.g. {@code "http://domain1.com"}.     * <p>These values are placed in the {@code Access-Control-Allow-Origin}     * header of both the pre-flight response and the actual response.     * {@code "*"} means that all origins are allowed.     * <p>If undefined, all origins are allowed.     * @see #value     */    @AliasFor("value")    String[] origins() default {};    /**     * List of request headers that can be used during the actual request.     * <p>This property controls the value of the pre-flight response‘s     * {@code Access-Control-Allow-Headers} header.     * {@code "*"}  means that all headers requested by the client are allowed.     * <p>If undefined, all requested headers are allowed.     */    String[] allowedHeaders() default {};    /**     * List of supported HTTP request methods, e.g.     * {@code "{RequestMethod.GET, RequestMethod.POST}"}.     * <p>Methods specified here override those specified via {@code RequestMapping}.     * <p>If undefined, methods defined by {@link RequestMapping} annotation     * are used.     */    RequestMethod[] methods() default {};}

从上面的代码可以看得出来,“注解”真的很“注解”,除了注释多和“元注解”多之外,真没有别的了。

“元注解”?什么是“元注解”呢?

“元注解”是用来注解(动词)注解(名词)的注解(名词)。请感受汉语的博大精深。@Target@Retention@Documented就是所谓的元注解。

1)@Target

Target是目标的意思,@Target指定了注解运用的场景。都有哪些场景值呢?

  • ElementType.ANNOTATION_TYPE:可以给注解进行注解
  • ElementType.CONSTRUCTOR:可以给构造方法进行注解
  • ElementType.FIELD:可以给字段进行注解
  • ElementType.LOCAL_VARIABLE:可以给局部变量进行注解
  • ElementType.METHOD:可以给方法进行注解
  • ElementType.PACKAGE:可以给包进行注解
  • ElementType.PARAMETER:可以给方法内的参数进行注解
  • ElementType.TYPE:可以给类型进行注解,比如类、接口和枚举

2)@Retention

Retention这个单词的意思为保留期。也就是说,当@Retention应用到一个注解上的时候,它解释说明了这个注解的存活时间。来看它的取值范围。

  • RetentionPolicy.SOURCE:注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
  • RetentionPolicy.CLASS:注解只被保留到编译进行的时候,并不会被加载到 JVM 中。
  • RetentionPolicy.RUNTIME:注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。

3)@Documented

Documented就比较容易理解,它和文档有关。作用就是能够将注解中的元素包含到 Javadoc 中。

当我们了解了元注解的概念后,再回头看一下@CrossOrigin的源码,是不是感觉清晰多了呢?

如果能够细致地读一读源码中的注释,你就会看到WebContextFilter类中出现的关键字,诸如Access-Control-Allow-OriginAccess-Control-Allow-HeadersAccess-Control-Allow-Methods。也就是说,当我们通过@CrossOrigin对Controller类注解后,SpringMVC就能够在运行时对这个类自动加上解决跨域问题的过滤器。

03、注解可以反射吗?

注解是可以通过反射获取的。

1)可以通过 Class 对象的 isAnnotationPresent() 方法判断该类是否应用了某个指定的注解。

2)通过 getAnnotation() 方法来获取注解对象。

3)当获取到注解对象后,就可以获取使用注解时定义的属性值。

示例如下:

@CrossOrigin(origins = "http://qingmiaokeji.com", allowedHeaders = "accept,content-type", methods = { RequestMethod.GET, RequestMethod.POST })public class TestController {    public static void main(String[] args) {        Class c = TestController.class;

        if (c.isAnnotationPresent(CrossOrigin.class)) {            CrossOrigin crossOrigin = (CrossOrigin) c.getAnnotation(CrossOrigin.class);

            System.out.println(Arrays.asList(crossOrigin.allowedHeaders()));            System.out.println(Arrays.asList(crossOrigin.methods()));            System.out.println(Arrays.asList(crossOrigin.origins()));        }

    }}

// 输出:[accept,content-type]// [GET, POST]// [http://qingmiaokeji.com]

04、注解经常用在哪里呢?

1)@Transactional:Spring 为事务管理提供的功能支持。

2)@ Service:Spring在进行包扫描的时候,会自动将这个类注册到Spring容器中。

3)@RestController:是@ResponseBody@Controller的组合注解。

也就是说,下面这段代码与下下面的代码等同。

@RestControllerpublic class HelloController {

    @RequestMapping(value="hello")    public String sayHello(){        return "hello";    }}
@Controller@ResponseBodypublic class HelloController {

    @RequestMapping(value="hello")    public String sayHello(){        return "hello";    }}

4)@RequestMapping :Spring Web 应用程序中最常用到的注解之一,将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上。

5)@Select:MyBatis提供的查询语句注解。示例如下:

@Select("select * from city")List<City> getCitys();

6)还有很多很多,就不再一一列举了。

最后

我想说的是,注解有许多用处,主要有:

  • 提供信息给编译器: 编译器可以利用注解来探测错误和警告信息。
  • 编译阶段时的处理: 软件工具可以利用注解信息来生成代码、HTML文档。
  • 运行时的处理: 某些注解可以在程序运行的时候接受代码的提取。

别忘了:

原文地址:https://www.cnblogs.com/qing-gee/p/10505627.html

时间: 2024-11-08 09:55:54

Java注解(Annotation):请不要小看我!的相关文章

java 注解Annotation

什么是注解? 注解,顾名思义,注解,就是对某一事物进行添加注释说明,会存放一些信息,这些信息可能对以后某个时段来说是很有用处的. java注解又叫java标注,java提供了一套机制,使得我们可以对方法.类.参数.包.域以及变量等添加标准(即附上某些信息).且在以后某个时段通过反射将标注的信息提取出来以供使用. 通过使用Annotation,程序开发人员可以在不改变的原有逻辑的情况下,在源文件嵌入一些补充的信息. Annotation可以用来修饰类.属性.方法,而且Annotation不影响程序

Java注解Annotation(一)

Java注解Annotation(一)--简介 这一章首先简单介绍一下注解,下一章会给出一个注解应用的DEMO. 1. 元注解 元注解的作用是负责注解其他的注解. JDK1.5中,定义了4个标准的meta-annotation元注解类型,他们被用来提供对其它annotation注解类型作说明. @Target @Retention @Documented @Inherited 这些类型和它们所支持的类在java.lang.annotation包中可以找到. @Target @Target说明了A

JAVA注解Annotation

JAVA注解Annotation JAVA注解Annotation 什么是注解 为什么要引入注解 JDK内建Annotation JDK元Annotation Annotation示例 自定义注解 提取Annotation信息 Annotation处理器编写 Annotation处理器处理异常 什么是注解? ??用一个词就可以描述注解,那就是元数据,即一种描述数据的数据.所以,可以说注解就是源代码的元数据.比如,下面这段代码: @Override publicString toString()

Java注解(Annotation)详解

转: Java注解(Annotation)详解 幻海流心 2018.05.23 15:20 字数 1775 阅读 380评论 0喜欢 1 Java注解(Annotation)详解 1.Annotation的概念 An annotation is a form of metadata, that can be added to Java source code. Classes, methods, variables, parameters and packages may be annotate

深入JAVA注解(Annotation):自定义注解 (转)

原文出自:http://blog.csdn.net/yjclsx/article/details/52101922 一.基础知识:元注解 要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法. 元注解: 元注解的作用就是负责注解其他注解.Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明.Java5.0定义的元注解: [email prote

【转】XML注释与Description标签及Java:注解(Annotation)的关系

NET中的规范标准注释(一) -- XML注释标签讲解 一.摘要 .Net允许开发人员在源代码中插入XML注释,这在多人协作开发的时候显得特别有用. C#解析器可以把代码文件中的这些XML标记提取出来,并作进一步的处理为外部文档. 这篇文章将展示如何使用这些XML注释. 在项目开发中,很多人并不乐意写繁杂的文档.但是,开发组长希望代码注释尽可能详细:项目规划人员希望代码设计文档尽可能详尽:测试.检查人员希望功能说明书尽可能详细等等.如果这些文档都被要求写的话,保持它们同步比进行一个战役还痛苦.

Java注解Annotation学习笔记

一.自定义注解 1. 使用关键字 @interface 2. 默认情况下,注解可以修饰 类.方法.接口等. 3. 如下为一个基本的注解例子: //注解中的成员变量非常像定义接口 public @interface MyAnnotation { //不带有默认值 String name(); //带有默认值 int age() default 20; } 4. Reflect中3个常见方法解读 getAnnotion(Class<T> annotationClass) 返回该元素上存在的,指定类

java注解(Annotation)解析

注解(Annotation)在java中应用非常广泛.它既能帮助我们在编码中减少错误,(比如最常见的Override注解),还可以帮助我们减少各种xml文件的配置,比如定义AOP切面用@AspectJ模式代替Schema模式,特别是最近接触了一点Spring MVC,每次编写Controller的时候用@RequestMapping(),@RequestParam,@ResponseBody等等. 我们所用的java中自带的注解都是定义好了的,直接拿来用,它就能发挥作用.当然了,自己也可以定义注

Java注解Annotation详解

注解是一种标记,在程序中加上某种注解就等于为程序打上了某种标记,在javac编译器,开发工具和其他程序可以用反射来了解你的类及各种元素上是否存在标记,存在什么标记,就去干相应的事.标记可以加在包,类,字段,方法,方法的参数以及局部变量上. 自定义注解及其应用 1).定义一个最简单的注解 public @interface MyAnnotation {     //...... } 2).把注解加在某个类上: @MyAnnotation public class AnnotationTest{  

深入理解java 注解(Annotation)重版

近期项目需要做权限验证,高手们写了一个权限验证的框架,看了一遍代码,还是和高手有差距啊~ 权限框架用到了一些注解反射啥的,所以回头看看以前写的文章<深入理解java 注解(Annotation)>,转过来,再做一些补充,做备忘使用. 一.什么是注解? 懒得去打了,搞一份wiki上的解释,自己看吧(以前可能会翻译一下,现在懒了) Annotation的使用方式及自定义注解 首先扫下盲,元注解就是Annotation的元注解一共有4个,分别为:@Target.@Retention.@Documen