附：Spring Boot 官方文档学习（一）入门及使用 见https://www.cnblogs.com/larryzeal/p/5799195.html

@RestController和@RequestMapping注解

4.0重要的一个新的改进是@RestController注解，它继承自@Controller注解。4.0之前的版本，Spring MVC的组件都使用@Controller来标识当前类是一个控制器servlet。使用这个特性，我们可以开发REST服务的时候不需要使用@Controller而专门的@RestController。

当你实现一个RESTful web services的时候，response将一直通过response body发送。为了简化开发，Spring 4.0提供了一个专门版本的controller。下面我们来看看@RestController实现的定义：

  1. @Target(value=TYPE)
  2. @Retention(value=RUNTIME)
  3. @Documented
  4. @Controller
  5. @ResponseBody
  6. public @interface RestController

@RequestMapping 注解提供路由信息。它告诉Spring任何来自"/"路径的HTTP请求都应该被映射到 home 方法。 @RestController 注解告诉Spring以字符串的形式渲染结果，并直接返回给调用者。

注： @RestController 和 @RequestMapping 注解是Spring MVC注解（它们不是Spring Boot的特定部分）

@EnableAutoConfiguration注解

第二个类级别的注解是 @EnableAutoConfiguration 。这个注解告诉Spring Boot根据添加的jar依赖猜测你想如何配置Spring。由于 spring-boot-starter-web 添加了Tomcat和Spring MVC，所以auto-configuration将假定你正在开发一个web应用并相应地对Spring进行设置。Starter POMs和Auto-Configuration：设计auto-configuration的目的是更好的使用"Starter POMs"，但这两个概念没有直接的联系。你可以自由地挑选starter POMs以外的jar依赖，并且Spring Boot将仍旧尽最大努力去自动配置你的应用。

你可以通过将 @EnableAutoConfiguration 或 @SpringBootApplication 注解添加到一个 @Configuration 类上来选择自动配置。
注：你只需要添加一个 @EnableAutoConfiguration 注解。我们建议你将它添加到主 @Configuration 类上。

如果发现应用了你不想要的特定自动配置类，你可以使用 @EnableAutoConfiguration 注解的排除属性来禁用它们。

  1. <pre name="code" class="java">import org.springframework.boot.autoconfigure.*;
  2. import org.springframework.boot.autoconfigure.jdbc.*;
  3. import org.springframework.context.annotation.*;
  4. @Configuration
  5. @EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
  6. public class MyConfiguration {
  7. }

@Configuration

Spring Boot提倡基于Java的配置。尽管你可以使用一个XML源来调用 SpringApplication.run() ，我们通常建议你使用 @Configuration 类作为主要源。一般定义 main 方法的类也是主要 @Configuration 的一个很好候选。你不需要将所有的 @Configuration 放进一个单独的类。 @Import 注解可以用来导入其他配置类。另外，你也可以使用 @ComponentScan 注解自动收集所有的Spring组件，包括 @Configuration 类。

如果你绝对需要使用基于XML的配置，我们建议你仍旧从一个 @Configuration 类开始。你可以使用附加的 @ImportResource 注解加载XML配置文件。

@Configuration注解该类，等价 与XML中配置beans；用@Bean标注方法等价于XML中配置bean

  1. @ComponentScan(basePackages = "com.hyxt",includeFilters = {@ComponentScan.Filter(Aspect.class)})

@SpringBootApplication

很多Spring Boot开发者总是使用 @Configuration ， @EnableAutoConfiguration 和 @ComponentScan 注解他们的main类。由于这些注解被如此频繁地一块使用（特别是你遵循以上最佳实践时），Spring Boot提供一个方便的 @SpringBootApplication 选择。
该 @SpringBootApplication 注解等价于以默认属性使用 @Configuration ， @EnableAutoConfiguration 和 @ComponentScan 。

  1. package com.example.myproject;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
  5. public class Application {
  6. public static void main(String[] args) {
  7. SpringApplication.run(Application.class, args);
  8. }
  9. }

Spring Boot将尝试校验外部的配置，默认使用JSR-303（如果在classpath路径中）。你可以轻松的为你的@ConfigurationProperties类添加JSR-303 javax.validation约束注解：

  1. @Component
  2. @ConfigurationProperties(prefix="connection")
  3. public class ConnectionSettings {
  4. @NotNull
  5. private InetAddress remoteAddress;
  6. // ... getters and setters
  7. }

@Profiles

Spring Profiles提供了一种隔离应用程序配置的方式，并让这些配置只能在特定的环境下生效。任何@Component或@Configuration都能被@Profile标记，从而限制加载它的时机。

  1. @Configuration
  2. @Profile("production")
  3. public class ProductionConfiguration {
  4. // ...
  5. }

@ResponseBody

表示该方法的返回结果直接写入HTTP response body中

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

@Component：

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。一般公共的方法我会用上这个注解
@AutoWired
byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构
造函数进行标注，完成自动装配的工作。
当加上（required=false）时，就算找不到bean也不报错。
@RequestParam：
用在方法的参数前面。

  1. @RequestParam String a =request.getParameter("a")。

@PathVariable:
路径变量。

  1. RequestMapping("user/get/mac/{macAddress}")
  2. public String getByMacAddress(@PathVariable String macAddress){
  3. //do something;
  4. }

参数与大括号里的名字一样要相同。

以上注解的示范
  1. /**
  2. * 用户进行评论及对评论进行管理的 Controller 类；
  3. */
  4. @Controller
  5. @RequestMapping("/msgCenter")
  6. public class MyCommentController extends BaseController {
  7. @Autowired
  8. CommentService commentService;
  9. @Autowired
  10. OperatorService operatorService;
  11. /**
  12. * 添加活动评论；
  13. *
  14. * @param applyId 活动 ID；
  15. * @param content 评论内容；
  16. * @return
  17. */
  18. @ResponseBody
  19. @RequestMapping("/addComment")
  20. public Map<String, Object> addComment(@RequestParam("applyId") Integer applyId, @RequestParam("content") String content) {
  21. ....
  22. return result;
  23. }
  24. }
  1. @RequestMapping("/list/{applyId}")
  2. public String list(@PathVariable Long applyId, HttpServletRequest request, ModelMap modelMap) {
  3. }

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

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

  1. /**
  2. * 全局异常处理
  3. */
  4. @ControllerAdvice
  5. class GlobalDefaultExceptionHandler {
  6. public static final String DEFAULT_ERROR_VIEW = "error";
  7. @ExceptionHandler({TypeMismatchException.class,NumberFormatException.class})
  8. public ModelAndView formatErrorHandler(HttpServletRequest req, Exception e) throws Exception {
  9. ModelAndView mav = new ModelAndView();
  10. mav.addObject("error","参数类型错误");
  11. mav.addObject("exception", e);
  12. mav.addObject("url", RequestUtils.getCompleteRequestUrl(req));
  13. mav.addObject("timestamp", new Date());
  14. mav.setViewName(DEFAULT_ERROR_VIEW);
  15. return mav;
  16. }}

通过@value注解来读取application.properties里面的配置

  1. # face++ key
  2. face_api_key = R9Z3Vxc7ZcxfewgVrjOyrvu1d-qR****
  3. face_api_secret =D9WUQGCYLvOCIdsbX35uTH********
  1. @Value("${face_api_key}")
  2. private String API_KEY;
  3. @Value("${face_api_secret}")
  4. private String API_SECRET;

注意使用這個注解的时候 使用@Value的类如果被其他类作为对象引用，必须要使用注入的方式，而不能new。这个很重要，我就是被这个坑了

所以一般常用的配置都是配置在application.properties文件的

转载于:https://www.cnblogs.com/lianxuan1768/p/8385618.html

spring boot 的常用注解使用 总结相关推荐

  1. Spring Boot中常见注解诠释

    一:@Mapper和@MapperScan 1.@Mapper @Mapper 将接口交给Spring进行管理,为这个接口生成一个实现类,让别的类进行引用.不再写mapper映射文件. @Mapper ...

  2. 注解参数获取不到_scm-springboot基于spring boot的统一注解缓存

    scm-springboot 基于spring boot的统一注解缓存,支持mencached.redis.ehcache的缓存无缝切换.支持单个缓存设置过期时间,灵活的key设置规则,采用fastj ...

  3. spring boot 自定义@EnableXXX注解

    前言 spring boot 自带了很多@EnableXXX这样的注解,通过这些注解我们可以很方便地启用某些功能,比如@EnableAutoConfiguration用来开启自动装配的功能.内部实现主 ...

  4. spring springboot springcloud常用注解

    @SpringBootApplication 组合注解,用在启动类上,源码: @Retention(RetentionPolicy.RUNTIME) @SpringBootConfiguration ...

  5. spring boot框架常用的一些玩意儿

    后端 A. maven管理依赖 聚合项目 B. 基础框架 spring boot C. 引入spring cloud微服务提供 版本netfilx 1.注册中心使用nacos Nacos Docker ...

  6. 二、Spring MVC之常用注解

    Spring MVC中常用的注解有以下几个:@Controller, @RequestMapping, @PathVariable, @CookieValue, @SessionAttributes. ...

  7. Spring Boot Starter 常用列表

    文章目录 1.美图 2.常用列表 3.源码中的starters 1.美图 2.常用列表 以下为常⽤用的 Spring Boot Starter 列列表. 名称 描述 Pom spring-boot-s ...

  8. spring boot中的注解

    spring boot是个好东西,可以不用容器直接在main方法中启动,而且无需配置文件,方便快速搭建环境. 1.@RequestMapping的params参数使用场景 当同一个类中的两个方法的功能 ...

  9. Spring+Spring Boot+Mybatis框架注解解析

    Restful 风格下的Spring Boot的注解开发 电商网站经常用到的restful风格 ,只是一种开发思想,不是开发框架,现在的技术并没有完全实现restful风格. restful风格是一种 ...

最新文章

  1. WebSocket的故事（六）—— Springboot中，实现更灵活的WebSocket
  2. linux实现机器之间的账号免密登陆
  3. 软件工程大学生职业生涯规划_大学生职业生涯规划的现实意义
  4. Win7和Win10安装VC6.0注意事项
  5. 单片机18b20c语言程序,AVR单片机控制DS18B20的示例C程序
  6. three.js两个点给线条加宽度_用感性的方式练习线条，凤尾花21，彩铅手绘教程...
  7. 谈谈分布式事务（Distributed Transaction）[共5篇]
  8. 使用ueditor实现多图片上传案例——Service层（IShoppingService）
  9. 工作45：注意公用方法 别混入
  10. c语言求树上节点的双亲,用非递归算法求二叉树叶子结点的c语言代码怎样写？...
  11. Oracle 11.2.0.3 Patchset
  12. Redis 低成本、高可用设计，牛逼！
  13. html简洁api文档模板,完整word版-API文档模板1.0.0.doc
  14. utf-8格式如何转化为gbk格式
  15. 12个月份的RGB配色
  16. 电脑显示网络计算机和设备不可见,win10系统网络发现已关闭看不到网络计算机和设备的解决方法...
  17. python如何速成_怎样速成python？
  18. autoit-v3 编辑工具SciTE Script Editor 解决中文乱码+中文换行崩溃问题
  19. 超声的pacs系统和dicom服务器,基于DICOM的PACS系统设计与实现
  20. Vue前端实战——外卖商家

热门文章

  1. Mysql找回管理员password
  2. Spark（四） -- Spark工作机制
  3. 【异步编程】Part3:取消异步操作
  4. HDU 2079 选课时间
  5. React Native学习（七）—— FlatList实现横向滑动列表效果
  6. numpy的索引-【老鱼学numpy】
  7. Xcode SVN配置
  8. jQuery 中的 Ajax
  9. Java设计模式-回调函数和观察者模式
  10. 软件开发者的最佳实践