40 个 SpringBoot 常用注解
逆锋起笔
共 8288字,需浏览 17分钟
· 2021-08-10
逆锋起笔
关注后回复编程pdf
来源:https://ramostear.com/
一、Spring Web MVC 与 Spring Bean 注解
Spring Web MVC 注解
RquestMappingHandlerMapping
和RequestMappingHndlerAdapter
两个类来提供对@RequestMapping注解的支持。@RequestMapping
注解对请求处理类中的请求处理方法进行标注;@RequestMapping
注解拥有以下的六个配置属性:value
:映射的请求URL或者其别名method
:兼容HTTP的方法名params
:根据HTTP参数的存在、缺省或值对请求进行过滤header
:根据HTTP Header的存在、缺省或值对请求进行过滤consume
:设定在HTTP请求正文中允许使用的媒体类型product
:在HTTP响应体中允许使用的媒体类型
HttpMessageConverter
传递的,根据请求主体中的参数名与对象的属性名进行匹配并绑定值。此外,还可以通过@Valid注解对请求主体中的参数进行校验。@RequestBody
的示例:@GetMapping
注解用于处理HTTP GET请求,并将请求映射到具体的处理方法中。具体来说,@GetMapping是一个组合注解,它相当于是@RequestMapping(method=RequestMethod.GET)
的快捷方式。@GetMapping
的一个使用示例:@PostMapping
注解用于处理HTTP POST请求,并将请求映射到具体的处理方法中。@PostMapping与@GetMapping一样,也是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.POST)
的快捷方式。@PostMapping
的一个示例:@PutMapping
注解用于处理HTTP PUT请求,并将请求映射到具体的处理方法中,@PutMapping是一个组合注解,相当于是@RequestMapping(method=HttpMethod.PUT)
的快捷方式。@PutMapping
的一个示例:@DeleteMapping
注解用于处理HTTP DELETE请求,并将请求映射到删除方法中。@DeleteMapping是一个组合注解,它相当于是@RequestMapping(method=HttpMethod.DELETE)
的快捷方式。@DeleteMapping
的一个示例:@PatchMapping
注解用于处理HTTP PATCH请求,并将请求映射到对应的处理方法中。@PatchMapping相当于是@RequestMapping(method=HttpMethod.PATCH)
的快捷方式。@ControllerAdvice
是@Component注解的一个延伸注解,Spring会自动扫描并检测被@ControllerAdvice所标注的类。@ControllerAdvice
需要和@ExceptionHandler
、@InitBinder
以及@ModelAttribute
注解搭配使用,主要是用来处理控制器所抛出的异常信息。@ControllerAdvice
所标注的类,在该类中,定义一个用于处理具体异常的方法,并使用@ExceptionHandler注解进行标记。@InitBinder
在类中进行全局的配置,还可以使用@ModelAttribute配置与视图相关的参数。使用@ControllerAdvice
注解,就可以快速的创建统一的,自定义的异常处理类。@ControllerAdvice
的示例代码:@ResponseBody
会自动将控制器中方法的返回值写入到HTTP响应中。特别的,@ResponseBody
注解只能用在被@Controller
注解标记的类中。如果在被@RestController
标记的类中,则方法不需要使用@ResponseBody
注解进行标注。@RestController
相当于是@Controller
和@ResponseBody
的组合注解。@ExceptionHander
注解用于标注处理特定类型异常类所抛出异常的方法。当控制器中的方法抛出异常时,Spring会自动捕获异常,并将捕获的异常信息传递给被@ExceptionHandler
标注的方法。@ResponseStatus
注解可以标注请求处理方法。使用此注解,可以指定响应所需要的HTTP STATUS。特别地,我们可以使用HttpStauts类对该注解的value属性进行赋值。@ResponseStatus
注解的一个示例:@PathVariable
注解是将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping
注解来指定URI的模板变量,然后使用@PathVariable
注解将方法中的参数绑定到模板变量上。@PathVariable
注解允许我们使用value或name属性来给参数取一个别名。下面是使用此注解的一个示例:{ }
进行包裹,如果方法的参数名与URI模板变量名一致,则在@PathVariable
中就可以省略别名的定义。@PathVariable
中设置require = false
@RequestParam
注解用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam
可以轻松的访问HTTP请求参数的值。@PathVariable
的配置相同,特别的,如果传递的参数为空,还可以通过defaultValue设置一个默认值。示例代码如下:@Controller
是@Component
注解的一个延伸,@RestController
是在Spring 4.0开始引入的,这是一个特定的控制器注解。此注解相当于@Controller
和@ResponseBody
的快捷方式。当使用此注解时,不需要再在方法上使用@ResponseBody
注解。@PathVariable
和@RequestParam
注解一样,如果参数名与模型具有相同的名字,则不必指定索引名称,简写示例如下:@ModelAttribute
对方法进行标注,Spring会将方法的返回值绑定到具体的Model上。示例如下:@ModelAttribute
注解标注的所有方法都将被执行。@CrossOrigin
注解将为请求处理类或请求处理方法提供跨域调用支持。如果我们将此注解标注类,那么类中的所有方法都将获得支持跨域的能力。使用此注解的好处是可以微调跨域行为。使用此注解的示例如下:@InitBinder
注解用于标注初始化WebDataBinider的方法,该方法用于对Http请求传递的表单数据进行处理,如时间格式化、字符串处理等。下面是使用此注解的示例:二、Spring Bean 注解
@ComponentScan
注解用于配置Spring需要扫描的被组件注解注释的类所在的包。可以通过配置其basePackages属性或者value属性来配置需要扫描的包路径。value属性是basePackages的别名。此注解的用法如下:@Service
注解是@Component
的一个延伸(特例),它用于标注业务逻辑类。与@Component
注解一样,被此注解标注的类,会自动被Spring所管理。下面是使用@Service
注解的示例:@Repository
注解也是@Component
注解的延伸,与@Component
注解一样,被此注解标注的类会被Spring自动管理起来,@Repository
注解用于标注DAO层的数据持久化类。此注解的用法如下:三、Spring Dependency Inject 与 Bean Scops注解
Spring DI注解
@DependsOn
注解可以配置Spring IoC容器在初始化一个Bean之前,先初始化其他的Bean对象。下面是此注解使用示例代码:initMethod
和destroyMethod
的用法。示例如下:Scops注解
singleton
、prototype
、request
、session
、globalSession
或者其他的自定义范围。这里以prototype为例子进行讲解。prototype:scope=“prototype”
,也可以使用@Scope注解设置,如下:@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)
四、容器配置注解
@Autowired
@Primary
this is send DingDing method message.
@PostConstruct与@PreDestroy
common-annotations.jar
中。@PostConstruct注解用于标注在Bean被Spring初始化之前需要执行的方法。@PreDestroy注解用于标注Bean被销毁前需要执行的方法。下面是具体的示例代码:@Qualifier
五、Spring Boot注解
@SpringBootApplication
注解是一个快捷的配置注解,在被它标注的类中,可以定义一个或多个Bean,并自动触发自动配置Bean和自动扫描组件。此注解相当于@Configuration
、@EnableAutoConfiguration
和@ComponentScan
的组合。@SpringBootApplication
public class Application{
public static void main(String [] args){
SpringApplication.run(Application.class,args);
}
}
@Configuration
@ConditionalOnClass(DataSource.class)
class MySQLAutoConfiguration {
//...
}
@Bean
@ConditionalOnBean(name="dataSource")
LocalContainerEntityManagerFactoryBean entityManagerFactory(){
//...
}
@Bean
@ConditionalOnMissingBean
public MyBean myBean(){
//...
}
@Bean
@ConditionalOnProperty(name="alipay",havingValue="on")
Alipay alipay(){
return new Alipay();
}
@ConditionalOnResource(resources = "classpath:website.properties")
Properties addWebsiteProperties(){
//...
}
@ConditionalOnWebApplication
HealthCheckController healthCheckController(){
//...
}
@Bean
@ConditionalException("${localstore} && ${local == 'true'}")
LocalFileStore store(){
//...
}
@Conditioanl(CustomConditioanl.class)
CustomProperties addCustomProperties(){
//...
}
总结
逆锋起笔
是一个专注于程序员圈子的技术平台,你可以收获最新技术动态
、最新内测资格
、BAT等大厂大佬的经验
、增长自身
、学习资料
、职业路线
、赚钱思维
,微信搜索逆锋起笔
关注!
看完本文有收获?请转发分享给更多人 前后端分离 Spring Boot + Vue 开发网易云、QQ音乐(附源码)!
点「在看」的人都变好看了哦
评论
真心建议大家搞个香港身份,再不冲就晚了
香港一直有“互联网荒漠”之称,疫情这三年,香港开始大力扶持互联网 科技工程 /IT产业,公布了《香港智慧城市蓝图》。目前规划已经覆盖到交通、医疗、经济、教育、环境等多个方面。目前在智能制造,5G网络、智慧城市等领域人才,通过香港优才计划入境都极具优势。什么是香港优才计划优才计划,全称优秀人才入境计划
公子龙
0
SpringBoot 实现图片防盗链功能
程序员的成长之路互联网/程序员/技术/资料共享 关注阅读本文大概需要 4 分钟。来自:blog.csdn.net/weixin_46157208/article/details/138051737前言出于安全考虑,我们需要后端返回的图片只允许在某个网站内展示,不想被爬虫拿到图片地
程序员的成长之路
0
springboot第70集:字节跳动后端三面经,一文让你走出微服务迷雾架构周刊
创建一个使用Kubernetes (K8s) 和 Jenkins 来自动化 GitLab 前端项目打包的CI/CD流水线,需要配置多个组件。下面,我将概述一个基本的设置步骤和示例脚本,以帮助你理解如何使用这些工具整合一个自动化流程。前提条件确保你已经有:Kubernetes 集群:用于部署 Jenk
程序源代码
0
顶级 Javaer 都在用的 20 个类库,真香!
点击关注公众号,Java 干货及时推送↓推荐阅读:投了 100 多份简历后…优秀且经验丰富的Java开发人员的特征之一是对API的广泛了解,包括JDK和第三方库。我花了很多时间来学习API,尤其是在阅读了Effective Java 3rd Edition之后 ,Joshua Bloch建
Java技术栈
1
雷军辟谣了!不是高考状元,卡里也没有冰冷的 40 亿
架构师大咖
架构师大咖,打造有价值的架构师交流平台。分享架构师干货、教程、课程、资讯。架构师大咖,每日推送。
公众号该公众号已被封禁最近很火的雷军简历,听说落魄时卡里只有冰冷的 40
源码共读
0
【第127期】推荐常用的国内外AI大模型
概述 多个国内外的AI大模型及其特点。以下是一些被提及的AI大模型和平台:全球大模型:ChatGPT:由OpenAI开发,支持多种语言,包括中文。Claude:由Anthropic开发,擅长深层次语言模式和复杂推理。Gemini:由Google Research开发,擅长自然语言理解和生成。Mis
前端微服务
0
6 个火爆 GitHub 的后台管理模板,快来收藏!
将Python客栈设为“星标⭐”第一时间收到最新资讯今天来给大家介绍6个火爆 G 站的管理后台模板,有了它们,对于前端不是很熟悉的小伙伴来说,再也不用烦恼了,而且有一说一,即使是前端大牛,要想从零开发一套完整的管理模板,也不是一件容易的事情。1. vue-element-admin该项目是基于 Vu
Python客栈
0
人工智能周刊#17:Llama3、微调 LLMs 的 PyTorch 原生库、李彦宏内部讲话、900 个最受欢迎的AI 工具
在内部讲话中,李彦宏对大模型开源与闭源的路线选择,以及 AI 创业者应该专注模型还是应用等业界焦点话题,发表了自己的看法。人工智能周刊:关注Python、机器学习、深度学习、大模型等硬核技术本期目录:1、Meta 最新发布 Llama 3 80 亿和 700 亿参数版本2、「抱抱脸」公
机器学习算法与Python实战
10