许昌市建设局网站,网站制作设计机构,rikka.top wordpress,四举措加强网站建设Spring中的注解
Spring中的注解大概可以分为两大类#xff1a;
spring的bean容器相关的注解#xff0c;或者说bean工厂相关的注解#xff1b;springmvc相关的注解。
spring的bean容器相关的注解#xff0c;先后有#xff1a;Required#xff0c; Autowired, PostConst…Spring中的注解
Spring中的注解大概可以分为两大类
spring的bean容器相关的注解或者说bean工厂相关的注解springmvc相关的注解。
spring的bean容器相关的注解先后有Required Autowired, PostConstruct, PreDestory还有Spring3.0开始支持的JSR-330标准javax.inject.*中的注解(Inject, Named, Qualifier, Provider, Scope, Singleton).
springmvc相关的注解有Controller, RequestMapping, RequestParam ResponseBody等等。
要理解Spring中的注解先要理解Java中的注解。
1. Java中的注解
Java中1.5中开始引入注解我们最熟悉的应该是Override, 它的定义如下
/*** Indicates that a method declaration is intended to override a* method declaration in a supertype. If a method is annotated with* this annotation type compilers are required to generate an error* message unless at least one of the following conditions hold:* The method does override or implement a method declared in a* supertype.* The method has a signature that is override-equivalent to that of* any public method declared in Object.** author Peter von der Aheacute;* author Joshua Bloch* jls 9.6.1.4 Override* since 1.5*/
Target(ElementType.METHOD)
Retention(RetentionPolicy.SOURCE)
public interface Override {
}从注释我们可以看出Override的作用是提示编译器使用了Override注解的方法必须override父类或者java.lang.Object中的一个同名方法。我们看到Override的定义中使用到了 Target, Retention它们就是所谓的“元注解”——就是定义注解的注解或者说注解注解的注解(晕了...)。我们看下Retention
/*** Indicates how long annotations with the annotated type are to* be retained. If no Retention annotation is present on* an annotation type declaration, the retention policy defaults to* RetentionPolicy.CLASS.*/
Documented
Retention(RetentionPolicy.RUNTIME)
Target(ElementType.ANNOTATION_TYPE)
public interface Retention {/*** Returns the retention policy.* return the retention policy*/RetentionPolicy value();
}Retention用于提示注解被保留多长时间有三种取值
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
}RetentionPolicy.SOURCE 保留在源码级别被编译器抛弃(Override就是此类)RetentionPolicy.CLASS被编译器保留在编译后的类文件级别但是被虚拟机丢弃
RetentionPolicy.RUNTIME保留至运行时可以被反射读取。
再看 Target:
package java.lang.annotation;/*** Indicates the contexts in which an annotation type is applicable. The* declaration contexts and type contexts in which an annotation type may be* applicable are specified in JLS 9.6.4.1, and denoted in source code by enum* constants of java.lang.annotation.ElementType* since 1.5* jls 9.6.4.1 Target* jls 9.7.4 Where Annotations May Appear*/
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();
}Target用于提示该注解使用的地方取值有
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
}分别表示该注解可以被使用的地方
类,接口注解enum;属性域方法参数构造函数局部变量注解类型包
所以
Target(ElementType.METHOD)
Retention(RetentionPolicy.SOURCE)
public interface Override {
}表示 Override 只能使用在方法上保留在源码级别被编译器处理然后抛弃掉。
还有一个经常使用的元注解 Documented
/*** Indicates that annotations with a type are to be documented by javadoc* and similar tools by default. This type should be used to annotate the* declarations of types whose annotations affect the use of annotated* elements by their clients. If a type declaration is annotated with* Documented, its annotations become part of the public API* of the annotated elements.*/
Documented
Retention(RetentionPolicy.RUNTIME)
Target(ElementType.ANNOTATION_TYPE)
public interface Documented {
}表示注解是否能被 javadoc 处理并保留在文档中。
2. 使用 元注解 来自定义注解 和 处理自定义注解
有了元注解那么我就可以使用它来自定义我们需要的注解。结合自定义注解和AOP或者过滤器是一种十分强大的武器。比如可以使用注解来实现权限的细粒度的控制——在类或者方法上使用权限注解然后在AOP或者过滤器中进行拦截处理。下面是一个关于登录的权限的注解的实现
/*** 不需要登录注解*/
Target({ ElementType.METHOD, ElementType.TYPE })
Retention(RetentionPolicy.RUNTIME)
Documented
public interface NoLogin {
}我们自定义了一个注解 NoLogin, 可以被用于 方法 和 类 上注解一直保留到运行期可以被反射读取到。该注解的含义是被 NoLogin 注解的类或者方法即使用户没有登录也是可以访问的。下面就是对注解进行处理了
/*** 检查登录拦截器* 如不需要检查登录可在方法或者controller上加上NoLogin*/
public class CheckLoginInterceptor implements HandlerInterceptor {private static final Logger logger Logger.getLogger(CheckLoginInterceptor.class);Overridepublic 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;}Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response,Object handler, ModelAndView modelAndView) throws Exception {}Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response,Object handler, Exception ex) throws Exception {}
}
上面我们定义了一个登录拦截器首先使用反射来判断方法上是否被 NoLogin 注解
NoLoginnoLoginhandlerMethod.getMethod().getAnnotation(NoLogin.class);
然后判断类是否被 NoLogin 注解
noLoginhandlerMethod.getMethod().getDeclaringClass().getAnnotation(NoLogin.class);
如果被注解了就返回 true如果没有被注解就判断是否已经登录没有登录则返回错误信息给前台和false. 这是一个简单的使用 注解 和 过滤器 来进行权限处理的例子。扩展开来那么我们就可以使用注解来表示某方法或者类只能被具有某种角色或者具有某种权限的用户所访问然后在过滤器中进行判断处理。
3. spring的bean容器相关的注解
1Autowired 是我们使用得最多的注解其实就是 autowirebyType 就是根据类型的自动注入依赖基于注解的依赖注入可以被使用再属性域方法构造函数上。
2Qualifier 就是 autowirebyName, Autowired注解判断多个bean类型相同时就需要使用 Qualifier(xxBean) 来指定依赖的bean的id
Controller
RequestMapping(/user)
public class HelloController {AutowiredQualifier(userService)private UserService userService;
3Resource 属于JSR250标准用于属性域额和方法上。也是 byName 类型的依赖注入。使用方式Resource(namexxBean). 不带参数的 Resource 默认值类名首字母小写。
4JSR-330标准javax.inject.*中的注解(Inject, Named, Qualifier, Provider, Scope, Singleton)。Inject就相当于Autowired, Named 就相当于 Qualifier, 另外 Named 用在类上还有 Component的功能。
5Component Controller, Service, Repository, 这几个注解不同于上面的注解上面的注解都是将被依赖的bean注入进入而这几个注解的作用都是生产bean, 这些注解都是注解在类上将类注解成spring的bean工厂中一个一个的bean。Controller, Service, Repository基本就是语义更加细化的Component。
6PostConstruct 和 PreDestroy 不是用于依赖注入而是bean 的生命周期。类似于 init-method(InitializeingBean) destory-method(DisposableBean)
4. spring中注解的处理
spring中注解的处理基本都是通过实现接口 BeanPostProcessor 来进行的
public interface BeanPostProcessor {Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException;Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException;
}相关的处理类有AutowiredAnnotationBeanPostProcessorCommonAnnotationBeanPostProcessorPersistenceAnnotationBeanPostProcessorRequiredAnnotationBeanPostProcessor
这些处理类可以通过 context:annotation-config/ 配置隐式的配置进spring容器。这些都是依赖注入的处理还有生产bean的注解(Component Controller, Service, Repository)的处理
context:component-scan base-packagenet.aazj.service,net.aazj.aop /
这些都是通过指定扫描的基包路径来进行的将他们扫描进spring的bean容器。注意context:component-scan也会默认将 AutowiredAnnotationBeanPostProcessorCommonAnnotationBeanPostProcessor 配置进来。所以context:annotation-config/是可以省略的。另外context:component-scan也可以扫描Aspect风格的AOP注解但是需要在配置文件中加入 aop:aspectj-autoproxy/ 进行配合。 SpringBoot 注解
使用注解的优势 采用纯java代码不在需要配置繁杂的xml文件 在配置中也可享受面向对象带来的好处 类型安全对重构可以提供良好的支持 减少复杂配置文件的同时亦能享受到springIoC容器提供的功能
1、注解详解配备了完善的释义 可采用 ctrlF 来进行搜索哦~~~~ SpringBootApplication申明让spring boot自动给程序进行必要的配置这个配置等同于Configuration EnableAutoConfiguration 和 ComponentScan 三个配置。 ResponseBody表示该方法的返回结果直接写入HTTP response body中一般在异步获取数据时使用用于构建RESTful的api。在使用RequestMapping后返回值通常解析为跳转路径加上esponsebody后返回结果不会被解析为跳转路径而是直接写入HTTP response body中。比如异步获取json数据加上Responsebody后会直接返回json数据。该注解一般会配合RequestMapping一起使用。 Controller用于定义控制器类在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口service层一般这个注解在类中通常方法需要配合注解RequestMapping。 RestController用于标注控制层组件(如struts中的action)ResponseBody和Controller的合集。 RequestMapping提供路由信息负责URL到Controller中的具体函数的映射。 EnableAutoConfigurationSpringBoot自动配置auto-configuration尝试根据你添加的jar依赖自动配置你的Spring应用。例如如果你的classpath下存在HSQLDB并且你没有手动配置任何数据库连接beans那么我们将自动配置一个内存型in-memory数据库”。你可以将EnableAutoConfiguration或者SpringBootApplication注解添加到一个Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类你可以使用EnableAutoConfiguration注解的排除属性来禁用它们。 ComponentScan表示将该类自动发现扫描组件。个人理解相当于如果扫描到有Component、Controller、Service等这些注解的类并注册为Bean可以自动收集所有的Spring组件包括Configuration类。我们经常使用ComponentScan注解搜索beans并结合Autowired注解导入。可以自动收集所有的Spring组件包括Configuration类。我们经常使用ComponentScan注解搜索beans并结合Autowired注解导入。如果没有配置的话Spring Boot会扫描启动类所在包下以及子包下的使用了Service,Repository等注解的类。 Configuration相当于传统的xml配置文件如果有些第三方库需要用到xml文件建议仍然通过Configuration类作为项目的配置主类——可以使用ImportResource注解加载xml配置文件。 Import用来导入其他配置类。 ImportResource用来加载xml配置文件。 Autowired自动导入依赖的bean Service一般用于修饰service层的组件 Repository使用Repository注解可以确保DAO或者repositories提供异常转译这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置同时也不需要为它们提供XML配置项。 Bean用Bean标注方法等价于XML中配置的bean。 Value注入Spring boot application.properties配置的属性的值。示例代码 Inject等价于默认的Autowired只是没有required属性 Component泛指组件当组件不好归类的时候我们可以使用这个注解进行标注。 Bean相当于XML中的,放在方法的上面而不是类意思是产生一个bean,并交给spring管理。 AutoWired自动导入依赖的bean。byType方式。把配置好的Bean拿来用完成属性、方法的组装它可以对类成员变量、方法及构造函数进行标注完成自动装配的工作。当加上requiredfalse时就算找不到bean也不报错。 Qualifier当有多个同一类型的Bean时可以用Qualifier(“name”)来指定。与Autowired配合使用。Qualifier限定描述符除了能根据名字进行注入但能进行更细粒度的控制如何选择候选者具体使用方式如下 Resource(name”name”,type”type”)没有括号内内容的话默认byName。与Autowired干类似的事。 2、注解列表如下 SpringBootApplication包含了ComponentScan、Configuration和EnableAutoConfiguration注解。其中 ComponentScan让spring Boot扫描到Configuration类并把它加入到程序上下文。 Configuration 等同于spring的XML配置文件使用Java代码可以检查类型安全。 EnableAutoConfiguration 自动配置。 ComponentScan 组件扫描可自动发现和装配一些Bean。 Component可配合CommandLineRunner使用在程序启动后执行一些基础任务。 RestController注解是Controller和ResponseBody的合集,表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器。 Autowired自动导入。 PathVariable获取参数。 JsonBackReference解决嵌套外链问题。 RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用。 3、JPA注解 EntityTable(name”“)表明这是一个实体类。一般用于jpa这两个注解一般一块使用但是如果表名和实体类名相同的话Table可以省略 MappedSuperClass用在确定是父类的entity上。父类的属性子类可以继承。 NoRepositoryBean一般用作父类的repository有这个注解spring不会去实例化该repository。 Column如果字段名与列名相同则可以省略。 Id表示该属性为主键。 GeneratedValue(strategy GenerationType.SEQUENCE,generator “repair_seq”)表示主键生成策略是sequence可以为Auto、IDENTITY、native等Auto表示可在多个数据库间切换指定sequence的名字是repair_seq。 SequenceGeneretor(name “repair_seq”, sequenceName “seq_repair”, allocationSize 1)name为sequence的名称以便使用sequenceName为数据库的sequence名称两个名称可以一致。 Transient表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为Transient,否则,ORM框架默认其注解为Basic。Basic(fetchFetchType.LAZY)标记可以指定实体属性的加载方式 JsonIgnore作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。 JoinColumnname”loginId”一对一本表中指向另一个表的外键。一对多另一个表指向本表的外键。 OneToOne、OneToMany、ManyToOne对应hibernate配置文件中的一对一一对多多对一。 4、springMVC相关注解 RequestMappingRequestMapping(“/path”)表示该控制器处理所有“/path”的UR L请求。RequestMapping是一个用来处理请求地址映射的注解可用于类或方法上。 用于类上表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有六个属性 params:指定request中必须包含某些参数值是才让该方法处理。 headers:指定request中必须包含某些指定的header值才能让该方法处理请求。 value:指定请求的实际地址指定的地址可以是URI Template 模式 method:指定请求的method类型 GET、POST、PUT、DELETE等 consumes:指定处理请求的提交内容类型Content-Type如application/json,text/html; produces:指定返回的内容类型仅当request请求头中的(Accept)类型中包含该指定类型才返回 RequestParam用在方法的参数前面。 RequestParam
String a request.getParameter(“a”)。
PathVariable:路径变量。 参数与大括号里的名字一样要相同。 5、全局异常处理 ControllerAdvice包含Component。可以被扫描到。统一处理异常。 ExceptionHandlerException.class用在方法上面表示遇到这个异常就执行以下方法。 6、项目中具体配置解析和使用环境 MappedSuperclass MappedSuperclass 注解使用在父类上面是用来标识父类的 MappedSuperclass 标识的类表示其不能映射到数据库表因为其不是一个完整的实体类但是它所拥有的属性能够映射在其子类对用的数据库表中 MappedSuperclass 标识的类不能再有Entity或Table注解 Column
1.当实体的属性与其映射的数据库表的列不同名时需要使用Column标注说明该属性通常置于实体的属性声明语句之前还可与 Id 标注一起使用。 2.Column 标注的常用属性是name用于设置映射数据库表的列名。此外该标注还包含其它多个属性如unique、nullable、length、precision等。具体如下 name属性name属性定义了被标注字段在数据库表中所对应字段的名称 unique属性unique属性表示该字段是否为唯一标识默认为false如果表中有一个字段需要唯一标识则既可以使用该标记也可以使用Table注解中的UniqueConstraint nullable属性nullable属性表示该字段是否可以为null值默认为true insertable属性insertable属性表示在使用”INSERT”语句插入数据时是否需要插入该字段的值 updateable属性updateable属性表示在使用”UPDATE”语句插入数据时是否需要更新该字段的值 insertable和updateable属性一般多用于只读的属性例如主键和外键等这些字段通常是自动生成的 columnDefinition属性columnDefinition属性表示创建表时该字段创建的SQL语句一般用于通过Entity生成表定义时使用如果数据库中表已经建好该属性没有必要使用 table属性table属性定义了包含当前字段的表名 length属性length属性表示字段的长度当字段的类型为varchar时该属性才有效默认为255个字符 precision属性和scale属性precision属性和scale属性一起表示精度当字段类型为double时precision表示数值的总长度scale表示小数点所占的位数 具体如下 double类型将在数据库中映射为double类型precision和scale属性无效 double类型若在columnDefinition属性中指定数字类型为decimal并指定精度则最终以columnDefinition为准 BigDecimal类型在数据库中映射为decimal类型precision和scale属性有效 precision和scale属性只在BigDecimal类型中有效 3.Column 标注的columnDefinition属性: 表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR,如果要将 String 类型映射到特定数据库的 BLOB 或TEXT字段类型. 4.Column标注也可置于属性的getter方法之前 Getter和SetterLombok Setter注解在属性上为属性提供 setting 方法 Getter注解在属性上为属性提供 getting 方法 Data注解在类上提供类所有属性的 getting 和 setting 方法此外还提供了equals、canEqual、hashCode、toString 方法 Setter注解在属性上为属性提供 setting 方法 Getter注解在属性上为属性提供 getting 方法 Log4j2 注解在类上为类提供一个 属性名为log 的 log4j 日志对象和Log4j注解类似 NoArgsConstructor注解在类上为类提供一个无参的构造方法 AllArgsConstructor注解在类上为类提供一个全参的构造方法 EqualsAndHashCode:默认情况下会使用所有非瞬态(non-transient)和非静态(non-static)字段来生成equals和hascode方法也可以指定具体使用哪些属性。 toString:生成toString方法默认情况下会输出类名、所有属性属性会按照顺序输出以逗号分割。 NoArgsConstructor, RequiredArgsConstructor and AllArgsConstructor无参构造器、部分参数构造器、全参构造器当我们需要重载多个构造器的时候只能自己手写了 NonNull注解在属性上如果注解了就必须不能为Null val:注解在属性上如果注解了就是设置为final类型可查看源码的注释知道 当你在执行各种持久化方法的时候实体的状态会随之改变状态的改变会引发不同的生命周期事件。这些事件可以使用不同的注释符来指示发生时的回调函数。 javax.persistence.PostLoad加载后。 javax.persistence.PrePersist持久化前。 javax.persistence.PostPersist持久化后。 javax.persistence.PreUpdate更新前。 javax.persistence.PostUpdate更新后。 javax.persistence.PreRemove删除前。 javax.persistence.PostRemove删除后。 1数据库查询
PostLoad事件在下列情况下触发 执行EntityManager.find()或getreference()方法载入一个实体后。 执行JPQL查询后。 EntityManager.refresh()方法被调用后。 2数据库插入
PrePersist和PostPersist事件在实体对象插入到数据库的过程中发生 PrePersist事件在调用persist()方法后立刻发生此时的数据还没有真正插入进数据库。 PostPersist事件在数据已经插入进数据库后发生。 3数据库更新
PreUpdate和PostUpdate事件的触发由更新实体引起 PreUpdate事件在实体的状态同步到数据库之前触发此时的数据还没有真正更新到数据库。 PostUpdate事件在实体的状态同步到数据库之后触发同步在事务提交时发生。 4数据库删除
PreRemove和PostRemove事件的触发由删除实体引起 PreRemove事件在实体从数据库删除之前触发即在调用remove()方法删除时发生此时的数据还没有真正从数据库中删除。 PostRemove事件在实体从数据库中删除后触发。
