Spring SpringMVC SpringBoot SpringCloud 注解整理大全

2024-05-27 09:44:08 96

本文内容纲要：

-SpringSpringMVCSpringBootSpringCloud注解整理

-Spring常用配置:

-springAOP切面编程（事务）注解:

-

-声明Bean的注解:

-@Enable*注解:

-SpringMVC常用注解:

-SpringBoot注解:

-springcloud常用注解

-Lombok提供注解方式

SpringSpringMVCSpringBootSpringCloud注解整理

才开的博客所以放了一篇以前整理的文档，如果有需要添加修改的地方欢迎指正，我会修改的φ(๑˃∀˂๑)♪

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("http://www.baidu.com")-->注入网址资源
- @Value("${book.name}")-->注入配置文件注意:使用的是$而不是#
@PostConstruct:在构造函数执行完之后执行
@PreDestroy:在Bean销毁之前执行
@ActiveProfiles:用来声明活动的profile
@profile:为不同环境下使用不同的配置提供了支持
- @Profile("dev").......对方法名为dev-xxxx的方法提供实例化Bean
@EnableAsync:开启异步任务的支持(多线程)
@Asyns:声明这是一个异步任务,可以在类级别和方法级别声明.
@EnableScheduling:开启对计划任务的支持(定时器)
@Scheduled:声明这是一个计划任务支持多种计划任务,包含cron.fixDelayfixRate
- @Scheduled(dixedDelay=5000)通过注解定时更新
@Conditional:条件注解,根据满足某一特定条件创建一个特定的Bean
@ContextConfiguration:加载配置文件
- @ContextConfiguration(classes={TestConfig.class})
- @ContextConfiguration用来加载ApplicationContext
- classes属性用来加载配置类
@WebAppCofiguration:指定加载ApplicationContext是一个WebApplicationContext

springAOP切面编程（事务）注解:

@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:开启对WebMVC的配置支持
@EnableAaspectJAutoProxy:开启Spring对这个切面(Aspect)的支持
@EnableConfigurationProperties开启对@ConfigurationProperties注解配置Bean的支持
@EnableJpaRepositories:开启对SpringDataJAPRepository的支持
@EnableTransactionManagement开启对注解式事物的支持
@EnableDiscoveryClient让服务发现服务器,使用服务器.Springcloud实现服务发现
@EnableEurekaServer注册服务器springcloud实现服务注册@
@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格式数据
@PathVariable:用来接收路径参数如/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

SpringBoot注解:

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

@SuppressWarnings注解

@SuppressWarnings("unchecked")
- 告诉编译器忽略unchecked警告信息,如使用listArrayList等未进行参数化产生的警告信息
@SuppressWarnings("serial")
- 如果编译器出现这样的警告信息:TheserializableclassWmailCalendardoesnotdeclareastaticfinalserialVersionUIDfieldoftypelong使用这个注释将警告信息去掉。
@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自动注入依赖
@Resourcebean的注入，同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执行之前执行，并且可以绑定参数到Modelmodel里面。
@Transactional（readOnly=true）注解式事务
@TransactionalEventListener用于配置事务的回调方法，可以在事务提交前、提交后、完成后以及回滚后几个阶段接受回调事件。
@Value（“${}”）可以注入properties里面的配置项
@ControllerAdvice是spring3提供的新注解
@ExceptionHandler如果在controller方法遇到异常，就会调用含有此注解的方法。
@InitBinder一般用于controller可以将所以form讲所有传递进来的string进行html编码，防止xss攻击，比如可以将字符串类型的日期转换成date类型
@EnableCaching注解自动化配置合适的缓存管理器。
@EnableWebSecurity注解开启springsecurity的功能，集成websercrityconfigureadapter。
@SringBootApplication相当于@configuration，@EnableAutoConfiguation@ComponentScan三个注解合用。
@EnableDiscoveryclient注册应用为Eureka客户端应用，以获得服务发现的能力
@EnableAdminServer使用admin监控应用。
@EnableEurekaClient配置本应用将使用服务注册和服务发现，注意：注册和发现用这个注解。
@EnableEurekaServer启动一个服务注册中心**@EnableHystrix表示启动断路器，断路器依赖于服务注册和发现。**
@HystrixCommand注解方法失败后，系统将西东切换到fallbackMethod方法执行。指定回调方法
@EnableCircuitBreaker//对hystrixR熔断机制的支持
@EnableAutoConfigurationspringboot自动配置，尝试根据你添加的jar依赖自动配置你的spring应用。
@ComponentScan表示将该类自动发现并注册bean可以自动收集所有的spring组件
@Comfiguration相当于传统的xml配置文件
@EnableHystrixDashboard//启动hystrixBoard服务监控
@Import导入其他配置类
@ImportResource用来加载xml配置文件
@RestController返回json字符串的数据，直接可以编写RESTFul的接口;
@CrossOrigin可以处理跨域请求，让你能访问不是一个域的文件;
@ApiOperation首先@ApiOperation注解不是Spring自带的，它是是swagger里的注解@ApiOperation是用来构建Api文档的@ApiOperation(value=“接口说明”,httpMethod=“接口请求方式”,response=“接口返回参数类型”,notes=“接口发布说明”；
@SpringBootApplication申明让springboot自动给程序进行必要的配置，等价于以默认属性使用@Configuration，@EnableAutoConfiguration和@ComponentScan;@RefreshScope如果代码中需要动态刷新配置，在需要的类上加上该注解就行。但某些复杂的注入场景下，这个注解使用不当，配置可能仍然不动态刷新;
@FeignClientspringboot调用外部接口:声明接口之后，在代码中通过@Resource注入之后即可使用。
@FeignClient标签的常用属性如下：name：指定FeignClient的名称，如果项目使用了Ribbon，name属性会作为微服务的名称，用于服务发现
@FeignClient注解中的fallbank属性指定回调类
@EnableFeignClients开启SpringCloudFeign的支持
@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)：使用链式结构

本文内容总结：SpringSpringMVCSpringBootSpringCloud注解整理，Spring常用配置:，springAOP切面编程（事务）注解:，，声明Bean的注解:，@Enable*注解:，SpringMVC常用注解:，SpringBoot注解:，springcloud常用注解，Lombok提供注解方式，

原文链接：https://www.cnblogs.com/wddhahaha/p/11744071.html