学习-常用注解

常用注解

@SpringBootApplication
@SpringBootApplication是一个复合注解,包括@ComponentScan,和@SpringBootConfiguration,@EnableAutoConfiguration

  • @SpringBootConfiguration继承自@Configuration,二者功能也一致,标注当前类是配置类,并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到srping容器中,并且实例名就是方法名
  • @EnableAutoConfiguration的作用启动自动的配置。
  • @EnableAutoConfiguration注解的意思就是Springboot根据你添加的jar包来配置你项目的默认配置,比如根据spring-boot-starter-web ,来判断你的项目是否需要添加了webmvc和tomcat,就会自动的帮你配置web项目中所需要的默认配置。
  • @ComponentScan,扫描当前包及其子包下被@Component,@Controller,@Service,@Repository注解标记的类并纳入到spring容器中进行管理。

@EnableJpaRepositories
@EnableJpaRepositories注解用于Srping JPA的代码配置,用于取代xml形式的配置文件

@EnableAspectJAutoProxy
表示开启AOP代理自动配置,如果配@EnableAspectJAutoProxy表示使用cglib进行代理对象的生成;设置@EnableAspectJAutoProxy(exposeProxy=true)表示通过aop框架暴露该代理对象,aopContext能够访问

@EnableScheduling & @Scheduled
定时任务在配置类上添加@EnableScheduling开启对定时任务的支持,在相应的方法上添加@Scheduled声明需要执行的定时任务。
其中Scheduled注解中有以下几个参数:

  • cron;
  • zone;
  • fixedDelay和fixedDelayString;
  • fixedRate和fixedRateString;
  • initialDelay和initialDelayString
  1. cron 是设置定时执行的表达式,如 0 0/5 * * * ?每隔五分钟执行一次
  2. zone 表示执行时间的时区
  3. fixedDelay和fixedDelayString 表示一个固定延迟时间执行,上个任务完成后,延迟多长时间执行
  4. fixedRate 和fixedRateString 表示一个固定频率执行,上个任务开始后,多长时间后开始执行
  5. initialDelay 和initialDelayString 表示一个初始延迟时间,第一次被调用前延迟的时间

@ConditionalOnProperty
控制某个configuration是否生效。具体操作是通过其两个属性name以及havingValue来实现的,其中name用来从application.properties中读取某个属性值,如果该值为空,则返回false;如果值不为空,则将该值与havingValue指定的值进行比较,如果一样则返回true;否则返回false。如果返回值为false,则该configuration不生效;为true则生效。

@PathVariable
@PathVariable绑定URI模板变量值
@PathVariable是用来获得请求url中的动态参数的
@PathVariable用于将请求URL中的模板变量映射到功能处理方法的参数上

@Repository
用于标注数据访问组件,即DAO组件。

@Service
用于标注业务层组件。

@RestController
用于标注控制层组件(如struts中的action),包含@Controller和@ResponseBody

@Controller
用于标注是控制层组件,需要返回页面时请用@Controller而不是@RestController

@Component
泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。

@ResponseBody
表示该方法的返回结果直接写入HTTP response body中。
一般在异步获取数据时使用,在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。
比如异步获取json数据,加上@responsebody后,会直接返回json数据

@RequestBody
参数前加上这个注解之后,认为该参数必填。表示接受json字符串转为对象 List等。

@ComponentScan
组件扫描。个人理解相当于,如果扫描到有@Component 、@Controller、@Service等这些注解的类,则把这些类注册为bean

@Configuration
指出该类是 Bean 配置的信息源,相当于XML中的,一般加在主类上。

@Bean
相当于XML中的,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理

@EnableAutoConfiguration
让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置,一般加在主类上

@AutoWired
byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错

@Qualifier
当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用

@Resource(name=”name”,type=”type”)
没有括号内内容的话,默认byName。与@Autowired干类似的事

@RequestMapping
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)类型中包含该指定类型才返回

@GetMapping、@PostMapping等
相当于@RequestMapping(value=”/”,method=RequestMethod.Get\Post\Put\Delete等) 。是个组合注解

@RequestParam
用在方法的参数前面。相当于 request.getParameter()。

@PathVariable:
路径变量。如

    RequestMapping(“user/get/mac/{macAddress}”)
    public String getByMacAddress(@PathVariable(“macAddress”) String macAddress){
        //do something;
    } 

参数与大括号里的名字相同的话,注解后括号里的内容可以不填


Jpa相关

@Entity:
@Table(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(fetch=FetchType.LAZY)
标记可以指定实体属性的加载方式

@JsonIgnore
作用是json序列化时将java bean中的一些属性忽略掉,序列化和反序列化都受影响

@JoinColumn(name="loginId")
一对一:本表中指向另一个表的外键。
一对多:另一个表指向本表的外键。

@OneToOne
@OneToMany
@ManyToOne

对应Hibernate配置文件中的一对一,一对多,多对一


全局异常处理相关

@ControllerAdvice
包含@Component。可以被扫描到。统一处理异常

@ExceptionHandler(Exception.class)
用在方法上面表示遇到这个异常就执行以下方法

springcloud相关

@EnableEurekaServer
用在springboot启动类上,表示这是一个eureka服务注册中心

@EnableDiscoveryClient
用在springboot启动类上,表示这是一个服务,可以被注册中心找到

@LoadBalanced
开启负载均衡能力

@EnableCircuitBreaker
用在启动类上,开启断路器功能

@HystrixCommand(fallbackMethod="backMethod")
用在方法上,fallbackMethod指定断路回调方法

@EnableConfigServer
用在启动类上,表示这是一个配置中心,开启Config Server

@EnableZuulProxy
开启zuul路由,用在启动类上

@SpringCloudApplication
包含@SpringBootApplication、@EnableDiscoveryClient、@EnableCircuitBreaker这三个注解

原文地址:https://www.cnblogs.com/zd-blogs/p/12015906.html

时间: 2024-11-09 09:56:03

学习-常用注解的相关文章

Spring学习(2)Spring 常用注解

Spring 常用注解 使用注解来构造IoC容器 用注解来向Spring容器注册Bean.需要在applicationContext.xml中注册<context:component-scanbase-package="pagkage1[,pagkage2,-,pagkageN]"/>. 如:在base-package指明一个包 1 <context:component-scan base-package="cn.gacl.java"/> 表

TestNG学习-002-annotaton 注解概述及其执行顺序

此文主要讲述用 TestNG 基础的 annotation (注解)知识,及其执行的顺序,并通过一个 TestNG 简单的实例演示 annotation 的执行顺序. 希望能对初学 TestNG 测试框架的亲们有所帮助.若有不足之处,敬请大神指正,不胜感激! 言归正传,以下为 TestNG 常用的 annotation 及其释义,敬请参阅. @BeforeSuite:被此注解的方法将在所有测试运行之前运行该方法. @AfterSuite: 被此注解的方法将在所有测试运行之后运行该方法. @Bef

[刘阳Java]_Spring常用注解介绍_第6讲

Spring的注解是在Spring2.5的版本中引入的,目的简化XML配置.在企业开发过程中使用注解的频率非常高,但是学习注解的前提是大家一定要对Spring基于XML配置要熟悉,这是我个人建议,因为在Spring2.0的版本时候是没有出现注解的使用 1. Spring常用注解如下 @Component @Autowired @Qualifier @Scope @Controller @Service @Repository 2. 使用Spring注解的时候一定关注Spring框架需要加入的包[

JAXB常用注解讲解(超详细)

简介: JAXB(Java Architecture for XML Binding) 是一个业界的标准,是一项可以根据XML Schema产生Java类的技术.该过程中,JAXB也提供了将XML实例文档反向生成Java对象树的方法,并能将Java对象树的内容重新写到XML实例文档.从另一方面来讲,JAXB提供了快速而简便的方法将XML模式绑定到Java表示,从而使得Java开发者在Java应用程序中能方便地结合XML数据和处理函数. 一个简单的例子: Person.class : @XmlRo

Spring-04.Spring的常用注解

认知: 学习基于注解的 IoC 配置,大家脑海里首先得有一个认知,即注解配置和 xml 配置要实现的功能都是一样 的,都是要降低程序间的耦合.只是配置的形式不一样. 1 常用IOC注解按照作用分类 曾经XML的配置: <bean id="accountService" class="com.itheima.service.impl.AccountServiceImpl" scope="" init-method="" d

【Spring基础学习】注解实现自动装配

在IOC容器中学习相关注解(常用) 1. @Autowired a.作用对象:(官网解释) 1. You can apply the @Autowired annotation to constructors: 2.you can also apply the @Autowired annotation to "traditional" setter methods: 3.You can also apply the annotation to methods with arbitra

android学习常用资料博客目录

android 技术总结 1.android 系统签名 介绍如何使用源码中的  (testkey:普通APK,默认情况下使用,platform:该APK完成一些系统的核心功能,经过对系统中存在的文件夹的访问测试,这种方式编译出来的APK所在进程的UID为system,shared:该APK需要和home/contacts进程共享数据,media:该APK是media/download系统中的一环.)4种密钥公钥进行签名. 2.MVC ListView 介绍什么是MVC以及MVC在SDK中的使用,

swagger2常用注解

本人常用注解说明: @ApiOperation:用在方法上,说明方法的作用     value: 表示接口名称     notes: 表示接口详细描述  @ApiImplicitParams:用在方法上包含一组参数说明 @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面 paramType:参数位置 header 对应注解:@RequestHeader query 对应注解:@RequestParam path  对应注解: @Path

Spring常用注解总结

传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺点:1.如果所有的内容都配置在.xml文件中,那么.xml文件将会十分庞大:如果按需求分开.xml文件,那么.xml文件又会非常多.总之这将导致配置文件的可读性与可维护性变得很低.2.在开发中在.java文件和.xml文件之间不断切换,是一件麻烦的事,同时这种思维上的不连贯也会降低开发的效率.为了解决这两个问题,Spring引入了注解,通过"@XXX"的方式,让注解与Java Bean紧密