Annotation 注解

Annotation 注解
- Java注解
  - 元注解
  - 自定义注解
- spring注解
  - bean容器注解
    - - @Component
      - @Configuration
  - springMVC注解

Java注解

注解不是程序本身，但可以对程序作出解释。(这一点，跟注释没什么区别)
可以被其他程序(比如：编译器等)读取。(注解信息处理流程，是注解和注释的重大区别。如果没有注解信息处理流程，则注解毫无意义)
注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如： @SuppressWarnings(value="unchecked")。
注解可以附加在package, class, method, field等上面，相当于给它们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问

元注解

元注解就是注解的注解，即用来定义注解的注解，使用元注解，用来自定义我们需要的注解，元注解有4个：@Target – @Retention – @Documented – @Inherited。其中@Target – @Retention两个注解是在自定义注解时必须给自定义注解添加的注解
@Retention:提示注解保留阶段ElementType.TYPE

SOURCE:源码级别，被编译器抛弃
CLASS:类文件级别，被vm抛弃
RUNTIME:保留到运行时，可以被反射读取

@Target：提示注解使用范围RetentionPolicy.TYPE

TYPE：类，接口，注解，枚举
FIELD：属性域
METHOD：方法
PARAMETER：参数
CONSTRUCTOR：构造函数
LOCAL_VARIABLE：局部变量
ANNOTATION_TYPE：注解类型
PACKAGE：包
TYPE_PARAMETER：类型参数注解
TYPE_USE：注解用途

@Document

@Inherited

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

自定义注解

自定义注解必须在注解前添加@Target – @Retention两个元注解来定义自定义注解的使用范围和保留阶段。同时自定义注解中还可以定义参数值即在注解中设置方法，因为每个注解自动继承了java.lang.annotation.Annotation接口，而在注解中定义方法实际上就是在为注解设置配置参数，这样在使用自定义注解时就必须向注解中传入参数值，或者在自定义方法中中设置default值就可以在使用自定义注解时不传入而使用默认值

定义注解的语法

解析注解

如果只定义注解则，注解就没有多大意义，重要的还有如何去解析注解
解析注解使用反射Class类来获取注解属性值

Annotation Class..getAnnotation(Annotation.class)：反射获取class的给定注解的注解
Annotation[] Class..getAnnotations()：反射获取class的所有注解

自定义注解示例

1.自定义一个登陆权限的注解

/**
 * 不需要登录注解
 */
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NoLogin {
}

2.在过滤器中使用注解

/**
 * 检查登录拦截器
 * 如不需要检查登录可在方法或者controller上加上@NoLogin
 */
public class CheckLoginInterceptor implements HandlerInterceptor {
    private static final Logger logger = Logger.getLogger(CheckLoginInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,  Object handler) throws Exception {
        if (!(handler instanceof HandlerMethod)) {
            logger.warn("当前操作handler不为HandlerMethod=" + handler.getClass().getName() + ",req="+ request.getQueryString());
            return true;
        }
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        String methodName = handlerMethod.getMethod().getName();
        // 判断是否需要检查登录
        NoLogin noLogin = handlerMethod.getMethod().getAnnotation(NoLogin.class);
        if (null != noLogin) {
            if (logger.isDebugEnabled()) {
                logger.debug("当前操作methodName=" + methodName + "不需要检查登录情况");
            }
            return true;
        }
        noLogin = handlerMethod.getMethod().getDeclaringClass().getAnnotation(NoLogin.class);
        if (null != noLogin) {
            if (logger.isDebugEnabled()) {
                logger.debug("当前操作methodName=" + methodName + "不需要检查登录情况");
            }
            return true;
        }
        if (null == request.getSession().getAttribute(CommonConstants.SESSION_KEY_USER)) {
            logger.warn("当前操作" + methodName + "用户未登录,ip=" + request.getRemoteAddr());
            response.getWriter().write(JsonConvertor.convertFailResult(ErrorCodeEnum.NOT_LOGIN).toString()); // 返回错误信息
            return false;
        }
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response,
                           Object handler, ModelAndView modelAndView) throws Exception {
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
                                Object handler, Exception ex) throws Exception {
    }
}

3.示例解释

1.首先使用反射来判断方法上是否被 @NoLogin 注解： NoLogin noLogin = handlerMethod.getMethod().getAnnotation(NoLogin.class);

2.然后判断类是否被 @NoLogin 注解：noLogin = handlerMethod.getMethod().getDeclaringClass().getAnnotation(NoLogin.class); 如果被注解了，就返回 true，如果没有被注解，就判断是否已经登录，没有登录则返回错误信息给前台和false. 这是一个简单的使用注解和过滤器来进行权限处理的例子。扩展开来，那么我们就可以使用注解，来表示某方法或者类，只能被具有某种角色，或者具有某种权限的用户所访问，然后在过滤器中进行判断处理。

spring注解

Spring中的注解大概可以分为两大类：
1）spring的bean容器相关的注解，或者说bean工厂相关的注解；
2）springmvc相关的注解。

bean容器注解

@Bean是一个方法级别上的注解，主要用在@Configuration注解的类里，也可以用在@Component注解的类里。添加的bean的id为方法名

@Configuration
public class AppConfig {
    @Bean
    public TransferService transferService() {
        return new TransferServiceImpl();
    }
}

上面的Bean注解就相当于如下配置

@Required，
@Autowired,：

是我们使用得最多的注解，其实就是 autowire=byType 就是根据类型的自动注入依赖（基于注解的依赖注入），可以被使用再属性域，方法，构造函数上

@PostConstruct,
@PreDestory

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

@Component

@Service用于标注业务层组件
@Controller用于标注控制层组件(如struts中的action)
@Repository用于标注数据访问组件，即DAO组件.
@Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注

@Configuration

@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。

注意：@Configuration注解的配置类有如下要求：

@Configuration不可以是final类型；
@Configuration不可以是匿名类；
嵌套的configuration必须是静态类。

springMVC注解

@Controller：控制器注解
@RequestMapping：请求路径
@RequestParam：请求参数
@ResponseBody：返回数据而不返回页面

@RestController注解相当于@ResponseBody ＋ @Controller

本博客为Swagger-Ranger的笔记分享，文中源码地址： https://github.com/Swagger-Ranger
欢迎交流指正，如有侵权请联系作者确认删除： liufei32@outlook.com

posted on 2019-04-08 13:07 Swagger-Ranger 阅读(563) 评论(0) 编辑收藏举报

刷新页面返回顶部

Swagger-Ranger