SpringBoot注解详解

1、关于Controller层的一些注解。

@ResponseBody 注解
@RequestBody注解
@RequestMapping注解
@RequestParam注解
@Controller注解

@ResponseBody 注解：将内容或对象作为 HTTP 响应正文（即响应体）返回，并调用适合HttpMessageConverter的Adapter转换对象，写入输出流。一般注释在方法上，意思就是将方法的返回值通过一定的转换发送给前端页面。
@RequestBody 注解：将HTTP请求正文（即请求体，post请求的内容）转换为适合的HttpMessageConverter对象。
@RequestMapping 注解：用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

例子：

@RequestMapping("/create")
@ResponseBody
public Result createProject(@RequestBody DevopsGitlabProject project) {   
   try {        
        Result<GitlabProject> result = new Result<>();          
        result.setResult(gitProjectService.createProject(project));        
        return result;   
   } catch (Exception e) {        
        logger.info(ErrorInfo.errorInfo(e));        
        return ErrorInfo.handError(e);    
  }
}

@RequestParam注解：匹配前台传来的参数给注解参数。比如下面前台传来的是project_id，匹配到projectId参数上。
例子如下：

@RequestMapping(“/project")
@ResponseBody
public Result deleteProject(@RequestParam(name = "project_id") Integer projectId) {    
    try {        
        Result<String> result = new Result<>();        
        gitProjectService.deleteProject(projectId);        
        result.setResult("分支已删除!");        
        return result;    
    } catch (IOException e) {        
        logger.info(ErrorInfo.errorInfo(e));        
        return ErrorInfo.handError(e);    
    }
}

关于Controller 类以及 @Controller 注解
1:spring mvc 中将 controller 认为是 MVC中的C --控制层
2：规范命名 类名 xxxController
3：如果不基于注解：该类需要继承 CommandController
如果基于注解： 在类名前加上 @controller
4：补充：将类名前加上该注解，当spring启动 或者web服务启动 spring会自动扫描所有包（当然，这个可以设置）
作用: 就是告诉服务器 这个类是MVC中的C 这个类可以接收用户请求 处理用户请求

备注：
@RequestMapping 注解的详解
理解：用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。
RequestMapping注解有六个属性，下面我们把她分成三类进行说明。
附注：属性就是指指写在注解后面括号里面的内容，即：@RequestMapping（属性1＝属性值，属性2=属性值....）
1、 value， method；
value： 指定请求的实际地址，指定的地址可以是URI Template 模式（后面将会说明）；默认RequestMapping("....str...")即为value的值；
method： 指定请求的method类型， GET、POST、PUT、DELETE等；
2、 consumes，produces；
consumes： 指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
produces: 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；
3、 params，headers；
params： 指定request中必须包含某些参数值是，才让该方法处理。
headers： 指定request中必须包含某些指定的header值，才能让该方法处理请求。

2、@Service层常用的注解
@Service注解
@Resource注解
@Autowired注解
@Resource注解
@Value注解

@Service注解：将service层对象注入到spring容器中，和xml配置文件中的<bean></bean>标签作用一样。

@Resource注解：注入bean对象

1. 如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常
2. 如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常
3. 如果指定了type，则从上下文中找到类型匹配的唯一bean进行装配，找不到或者找到多个，都会抛出异常
4. 如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配；

@Autowired：按byType自动注入对象
@Autowired 与@Resource的区别：
1、 @Autowired与@Resource都可以用来装配bean. 都可以写在字段上,或写在setter方法上。
2、 @Autowired默认按类型装配（这个注解是属业spring的），默认情况下必须要求依赖对象必须存在，如果要允许null值，可以设置它的required属性为false，如：@Autowired(required=false) ，如果我们想使用名称装配可以结合@Qualifier注解进行使用，如下：
@Autowired()
@Qualifier("baseDao”)
private BaseDao baseDao;

附注：关于ByName和Bytype的使用，ByName的意思是在容器中找到与注释下的变量名一致的对象注入给变量。ByType就是找到上下文与注释下的变量类型一致的类对象的类型，注入给注释下的变量。
推荐使用：@Resource注解在字段上，这样就不用写setter方法了，并且这个注解是属于J2EE的，减少了与spring的耦合。这样代码看起就比较优雅。

@Value注解意思：在connection中有的，指定资源文件中的某个变量值。
例子如下：
@Value("${git_host}")private String HOSTNAME;

@Transactional注解的作用：事务处理，当删除出现异常，回滚之前删除的。
注意：删除的操作必须要有@ Transactional注解，添加和修改也要有这个注解
例子如下：

@Override
@Transactional
public void deleteUser(Integer userId) throws IOException {    
      aclUserRepository.deleteUser(userId);            
      gitlabAPI.deleteUser(userId);
}

 

1.@EnableDiscoveryClient

2.@RestController

用于标注控制层组件(如struts中的action)，@ResponseBody和@Controller的合集。

3.@Controller

用于定义控制器类，在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping。

4.@SpringBootApplication

@SpringBootApplication：申明让spring boot自动给程序进行必要的配置，这个配置等同于：@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三个配置。

5.@Autowired

自动导入依赖的bean

6.@Service：

一般用于修饰service层的组件

7.@RequestMapping

提供路由信息，负责URL到Controller中的具体函数的映射。

9.@Configuration 

9.@EnableAutoConfiguration 

10.@ComponentScan

11.@ResponseBody

表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，用于构建RESTful的api。

 

参考资料：https://www.jianshu.com/p/943a25dcbe96