Spring SpringMVC SpringBoot SpringCloud 注解整理大全

程序员文章站 2022-05-09 14:17:49

Spring SpringMVC SpringBoot SpringCloud 注解整理这段时间学习了一些框架，里面用到了很多注解，记不住所以把遇到的注解都整理了下来，如果有不对的地方欢迎指正，我会修改的φ(๑˃∀˂๑)♪ Spring 常用配置: @import :导入配置类 @Scope : ......

spring springmvc springboot springcloud 注解整理

这段时间学习了一些框架，里面用到了很多注解，记不住所以把遇到的注解都整理了下来，如果有不对的地方欢迎指正，我会修改的φ(๑˃∀˂๑)♪

spring 常用配置:

@import :导入配置类
@scope : 新建bean的实例 @scope("prototype") 声明scope 为 prototype
@value : 属性注入
- @value ("我爱你") --> 普通字符串注入
- @value ("#{systemproperties['os.name']}") -->注入操作系统属性
- @value ("#{ t (java.lang.math).random() * 100.0 }") --> 注入表达式结果
- @value ("#{demoservice.another}") --> 注入其他bean属性
- @value ( "classpath:com/wisely/highlight_spring4/ch2/el/test.txt" ) --> 注入文件资源
- @value ("")-->注入网址资源
- @value ("${book.name}" ) --> 注入配置文件注意: 使用的是$ 而不是 #
@postconstruct : 在构造函数执行完之后执行
@predestroy : 在 bean 销毁之前执行
@activeprofiles : 用来声明活动的 profile
@profile: 为不同环境下使用不同的配置提供了支持
- @profile("dev") .......对方法名为 dev-xxxx的方法提供实例化bean
@enableasync : 开启异步任务的支持(多线程)
@asyns : 声明这是一个异步任务,可以在类级别和方法级别声明.
@enablescheduling : 开启对计划任务的支持(定时器)
@scheduled : 声明这是一个计划任务支持多种计划任务,包含 cron. fixdelay fixrate
- @scheduled (dixeddelay = 5000) 通过注解定时更新
@conditional : 条件注解,根据满足某一特定条件创建一个特定的bean
@contextconfiguration : 加载配置文件
- @contextconfiguration(classes = {testconfig.class})
- @contextconfiguration用来加载applicationcontext
- classes属性用来加载配置类
@webappcofiguration : 指定加载 applicationcontext是一个webapplicationcontext

spring aop切面编程（事务）注解:

@aspect : 声明这是一个切面
@after @before. @around @afterthrowing @afterreturning
定义切面，,可以直接将拦截规则(切入点 pointcut)作为参数
@pointcut : 专门定义拦截规则然后在 @after @before. @around 中调用
@transcational : 事务处理
@enabletransactionmanagement 开启对注解式事物的支持
@cacheable : 数据缓存
@enableaaspectjautoproxy : 开启spring 对这个切面(aspect )的支持
@target (elementtype.type):元注解,用来指定注解修饰类的那个成员 -->指定拦截规则
@retention(retentionpolicy.runtime)
- --->当定义的注解的@retention为runtime时，才能够通过运行时的反射机制来处理注解.-->指定拦截规则

声明bean的注解:
- @component : 组件,没有明确的角色
- @service : 在业务逻辑层(service层)使用
- @repository : 在数据访问层(dao层)使用.
- @controller : 在展现层(mvc--springmvc)使用
注入bean的注解:
- @aautowired : spring提供的注解.
- @inject : jsr-330提供的注解
- @resource : jsr-250提供的注解
配置文件的注解:
- @configuration : 声明当前类是个配置类,相当于一个spring配置的xml文件.
- @componentscan (cn.test.demo): 自动扫描包名下所有使用 @component @service @repository @controller 的类,并注册为bean
- @wiselyconfiguration : 组合注解可以替代 @configuration和@componentscan
- @bean : 注解在方法上,声明当前方法的返回值为一个bean.
- @bean(initmethod="aa",destroymethod="bb")--> 指定 aa和bb方法在构造之后.bean销毁之前执行.

**@enable*注解:**

@enableasync : 开启异步任务的支持(多线程)
@enablescheduling : 开启对计划任务的支持(定时器)
@enablewebmvc : 开启对web mvc 的配置支持
@enableaaspectjautoproxy : 开启spring 对这个切面(aspect )的支持
@enableconfigurationproperties 开启对@configurationproperties注解配置bean的支持
@enablejparepositories : 开启对spring data jap repository 的支持
@enabletransactionmanagement 开启对注解式事物的支持
@enablediscoveryclient 让服务发现服务器,使用服务器.spring cloud 实现服务发现
@enableeurekaserver 注册服务器 spring cloud 实现服务注册@
@enablescheduling 定时器！让spring可以进行任务调度,功能类似于spring.xml文件中的命名空间
@enablecaching 开启cache缓存支持;

springmvc 常用注解:

@controller : 注解在类上声明这个类是springmvc里的controller,将其声明为一个spring的bean.
@requestmapping :可以注解在类上和方法上映射web请求(访问路径和参数)
@requestmapping(value= "/convert",produces+{"application/x-wisely"}) 设置访问url 返回值类型
@responsebody : 支持将返回值放入response体内返回json格式数据！而不是返回一个页面(返回的是一个组数据)
@requestbody : 允许request的参数在request体中,而不是直接连接在地址后面次注解放置在参数前获取体中的json格式数据
@path variable : 用来接收路径参数如/test/001,001为参数,次注解放置在参数前
@restcontroller : @controller + @responsebody 组合注解
@controlleradvice : 通过@controlleradvice可以将对已控制器的全局配置放置在同一个位置
@exceptionhandler : 用于全局处理控制器的异常
@exceptionhandier(value=exception.class) -->通过value属性可过滤拦截器条件,拦截所有的异常
@initbinder : 用来设置webdatabinder , webdatabinder用来自动绑定前台请求参数到model中.
@modelattrbuute : 绑定键值对到model中,
@runwith : 运行器
- @runwith(junit4.class)就是指用junit4来运行
- @runwith(springjunit4classrunner.class),让测试运行于spring测试环境
- @runwith(suite.class)的话就是一套测试集合，
@webappconfiguration("src/main/resources") : 注解在类上,用来声明加载的applicationcontex 是一个webapplicationcontext ,它的属性指定的是web资源的位置,默认为 src/main/webapp ,自定义修改为 resource
@before : 在 xxx 前初始化
@requestmapping

@requestparam

@responsebody

@requestbody

@pathvariable

@restcontroller

@cookievalue

@modelattributes

@sessionattributes

spring boot 注解:

@springbootapplication : 是spring boot 项目的核心注解主要目的是开启自动配置
- @springbootapplication注解是一个组合注解,主要组合了@configuration .+@enableautoconfiguration.+@componentscan
@value : 属性注入,读取properties或者 yml 文件中的属性
@configurationproperties : 将properties属性和一个bean及其属性关联,从而实现类型安全的配置
- @configurationproperties(prefix = "author",locations = {"classpath:config/author.properties"})
- 通过@configurationproperties加载配置,通过prefix属性指定配置前缀,通过location指定配置文件位置
@enableautoconfiguration 注解:作用在于让 spring boot 根据应用所声明的依赖来对 spring 框架进行自动配置这个注解告诉spring boot根据添加的jar依赖猜测你想如何配置spring。由于spring-boot-starter-web添加了tomcat和spring mvc，所以auto-configuration将假定你正在开发一个web应用并相应地对spring进行设置。
@ configuration 注解，以明确指出该类是 bean 配置的信息源
@componentscan 注解会告知spring扫描指定的包来初始化spring bean这能够确保我们声明的bean能够被发现。
@importresource 注解加载xml配置文件
@enableautoconfiguration(exclude={xxxx.class}) 禁用特定的自动配置
@springbootapplication 注解等价于以默认属性使用@configuration，@enableautoconfiguration和 @componentscan。

@suppresswarnings注解

@suppresswarnings("unchecked")
- 告诉编译器忽略 unchecked 警告信息,如使用 list arraylist等未进行参数化产生的警告信息
@suppresswarnings("serial")
- 如果编译器出现这样的警告信息: the serializable class wmailcalendar does not declare a static final serialversionuid field of type long 使用这个注释将警告信息去掉。
@suppresswarnings("deprecation")
- 如果使用了使用@deprecated注释的方法，编译器将出现警告信息。使用这个注释将警告信息去掉。
@suppresswarnings("unchecked", "deprecation")
- 告诉编译器同时忽略unchecked和deprecation的警告信息。
@suppresswarnings(value={"unchecked", "deprecation"})
- 等同于@suppresswarnings("unchecked", "deprecation")

案例

@entity : 映射数据库实体类

@table(name ="s_produceinfo") : 表名为 "s_produceinfo"

@id : 声明主键id

@column(name ="app_name", unique =**true**, length = 50) :对应数据库字段,属性

@enumerated(enumtype.**string**) : 采用枚举值类型和数据库字段进行交互 

@temporal : 时间格式 映射数据库会得到规定时间格式的日期

•       @enumerted(enumtype.string)  hh:mm:ss 格式的日期

•      @enumerted(enumtype.date) 获取年月日  yyyy-mm-dd 

•       @enumerted(enumtype.time) 获取时分秒  hh:mm:ss

•

springcloud 常用注解

@controller 控制层，里面有多个连接
@service 业务层，一般对于接口和实现
@qualifier 如果一个接口有多个实现，那么注入时候加上唯一标示
@repository 一般的dao层
@autowired 自动注入依赖
@resource bean的注入，同autowired 有相同的功能。
@resource和@autowired区别说明：

共同点：@resource和@autowired都可以作为注入属性的修饰，在接口仅有单一实现类时，两个注解的修饰效果相同，可以互相替换，不影响使用。

不同点： @resource是java自己的注解，@resource有两个属性是比较重要的，分是name和type；spring将@resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以如果使用name属性，则使用byname的自动注入策略，而使用type属性时则使用bytype自动注入策略。如果既不指定name也不指定type属性，这时将通过反射机制使用byname自动注入策略。 @autowired是spring的注解，是spring2.5版本引入的，autowired只根据type进行注入，不会去匹配name。如果涉及到type无法辨别注入对象时，那需要依赖@qualifier或@primary注解一起来修饰。

@component定义其它组件（比如访问外部服务的组件）
@requestmapping （value=’’,method={requestmethod。get或者post}）绑定url
@requestparam (value=’’ required=false)绑定参数,将客户端请求中的参数值映射到相应方法的参数上;
@modelattribute 一般用于controller层，呗注解的方法会在所以mapping执行之前执行，并且可以绑定参数到model model里面。
@transactional （readonly=true）注解式事务
@transactionaleventlistener用于配置事务的回调方法，可以在事务提交前、提交后、完成后以及回滚后几个阶段接受回调事件。
@value（“${}”）可以注入properties里面的配置项
@controlleradvice 是spring3提供的新注解
@exceptionhandler 如果在controller方法遇到异常，就会调用含有此注解的方法。
@initbinder 一般用于controller 可以将所以form 讲所有传递进来的string 进行html编码，防止xss攻击，比如可以将字符串类型的日期转换成date类型
@enablecaching 注解自动化配置合适的缓存管理器。
@enablewebsecurity 注解开启spring security的功能，集成websercrityconfigureadapter。
@sringbootapplication相当于@configuration，@enableautoconfiguation @componentscan三个注解合用。
@enablediscoveryclient 注册应用为eureka客户端应用，以获得服务发现的能力
@enableadminserver 使用admin监控应用。
@enableeurekaclient配置本应用将使用服务注册和服务发现，注意：注册和发现用这个注解。
@enableeurekaserver 启动一个服务注册中心 @enablehystrix表示启动断路器，断路器依赖于服务注册和发现。
@hystrixcommand注解方法失败后，系统将西东切换到fallbackmethod方法执行。指定回调方法
@enablecircuitbreaker//对hystrixr熔断机制的支持
@enableautoconfiguration spring boot自动配置，尝试根据你添加的jar依赖自动配置你的spring应用。
@componentscan 表示将该类自动发现并注册bean 可以自动收集所有的spring组件
@comfiguration 相当于传统的xml配置文件
@enablehystrixdashboard//启动hystrix board 服务监控
@import 导入其他配置类
@importresource用来加载xml配置文件
@restcontroller 返回json字符串的数据，直接可以编写restful的接口;
@crossorigin 可以处理跨域请求，让你能访问不是一个域的文件;
@apioperation 首先@apioperation注解不是spring自带的，它是是swagger里的注解@apioperation是用来构建api文档的@apioperation(value = “接口说明”, httpmethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”；
@springbootapplication　　申明让spring boot自动给程序进行必要的配置，等价于以默认属性使用@configuration，@enableautoconfiguration和@componentscan; @refreshscope　如果代码中需要动态刷新配置，在需要的类上加上该注解就行。但某些复杂的注入场景下，这个注解使用不当，配置可能仍然不动态刷新;
@feignclient　springboot调用外部接口:声明接口之后，在代码中通过@resource注入之后即可使用。
@feignclient标签的常用属性如下：name：指定feignclient的名称，如果项目使用了ribbon，name属性会作为微服务的名称，用于服务发现
@feignclient注解中的fallbank属性指定回调类
@enablefeignclients 开启spring cloud feign的支持
@enablecircuitbreaker 开启断路器功能
@loadbalanced 开启客户端负载均衡
@webappconfiguration 开启web 应用的配置，用于模拟servletcontext
@ribbonclient，这个注解用来为负载均衡客户端做一些自定义的配置，可以进一步配置或自定义从哪里获取服务端列表、负载均衡策略、ping也就是服务鉴活策略等等

lombok提供注解方式

目的：来提高代码的简洁性,常用注解概览:

- @data：注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canequal、hashcode、tostring 方法,相当于同时加上以下注解@setter @getter,@tostring,@equalsandhashcode
- @setter、@getter：注解在类和属性上；为属性提供 setting、getting 方法
- @tostring：生成tostring方法，默认情况下，会输出类名、所有属性，属性按照顺序输出，以逗号分割。
- @equalsandhashcode：实现equals()方法和hashcode()方法
- *@builder：构建建造者模式*
- @nonnull：该注解快速判断是否为空,如果为空,则抛出java.lang.nullpointerexception
- @synchronized：该注解自动添加到同步机制,有趣的是,生成的代码并不是直接锁方法,而是锁代码块，作用范围是方法上
- @log4j ：注解在类上；为类提供一个属性名为log 的 log4j 日志对象
- *@noargsconstructor：注解在类上；为类提供一个无参的构造方法*
- @requiredargsconstructor：注解在类上；为类提供一个部分参的构造方法(使用类中所有带有@nonnull注解的或者带有final修饰的成员变量生成对应的构造方法)
- *@allargsconstructor：注解在类上；为类提供一个全参的构造方法*
- @cleanup：用于确保已分配的资源被释放,如io的连接关闭
- @sneakythrows：抛异常
- @accessors(chain = true)：使用链式结构

上一篇： oracle 字符串转成行

下一篇：关于尾递归的使用详解_php实例