1.springmvc注解
1. @RestController、@ResponseBody、@Controller
@Controller是@Component注解的一个延伸,Spring会自动扫描并配置被该注解标注的类,是一个controller层必需的注解。@ResponseBody会自动将控制器中方法的返回值写入到HTTP响应中。
@RestController相当于@Controller和@ResponseBody,最常使用,上面两个就基本用不到了。
2. @RequestMapping、@GetMapping、@PostMapping
@RequestMapping注解的主要用途是将Web请求与请求处理类中的方法进行映射,可以注解在类或方法上。
拥有6个配置属性:
- value:映射的请求URL或者其别名
- method:兼容HTTP的方法名
- params:根据HTTP参数的存在、缺省或值对请求进行过滤
- headers:根据HTTP Header的存在、缺省或值对请求进行过滤
- consumes:设定在HTTP请求正文中允许使用的媒体类型
- products:在HTTP响应体中允许使用的媒体类型
@GetMapping和@PostMapping是省略method的写法,推荐使用。
例:
@RestController
@RequestMapping("/person")
public class UserController {
@RequestMapping(value = "/query", method = RequestMethod.GET)
public String query(){
return "11";
}
@GetMapping(value = "/query")
public String getUser(){
return "11";
}
@PostMapping(value = "/add")
public String addUser(){
return "11";
}
}
3.@RequestBody、@PathVariable、@RequestParam
@RequestBody在处理请求方法的参数列表中使用,它可以将请求主体中的参数绑定到一个对象中,请求主体参数是通过HttpMessageConverter传递的,根据请求主体中的参数名与对象的属性名进行匹配并绑定值。此外,还可以通过@Valid注解对请求主体中的参数进行校验。下面是一个使用@RequestBody的示例:
@RestController
@Validated
public class UserController {
@PostMapping(value = "/add")
public BaseResponse addUser(@Validated @RequestBody UserAddDto addDto) {
return new BaseResponse<>();
}
}
@PathVariable注解是将方法中的参数绑定到请求URI中的模板变量上,模板变量名需要使用“{ }”进行包裹,如果方法的参数名与URI模板变量名一致,则在@PathVariable中就可以省略别名的定义。
@RequestParam注解用于将方法的参数与Web请求的传递的参数进行绑定,特别的get方式的请求中,可以用一个dto对象来接收参数,前面不加@RequestParam即可。
@GetMapping(value = "/query/{id}")
public BaseResponse<CountGroupDto> getCountGroup(@PathVariable(name = "id") String id,
@RequestParam("name") String name) {
BaseResponse<CountGroupDto> response = new BaseResponse<>();
CountGroupDto countGroupDto = new CountGroupDto();
countGroupDto.setId(id);
countGroupDto.setName(name);
response.setData(countGroupDto);
return response;
}
4. @CrossOrigin、@InitBinder
@CrossOrigin注解将为请求处理类或请求处理方法提供跨域调用支持。如果我们将此注解标注类,那么类中的所有方法都将获得支持跨域的能力。使用此注解的好处是可以微调跨域行为。
@InitBinder注解用于标注初始化WebDataBinider的方法,该方法用于对Http请求传递的表单数据进行处理,如时间格式化、字符串处理等。下面是使用此注解的示例:
@InitBinder
public void initBinder(WebDataBinder binder){
CustomDateEditor editor = new CustomDateEditor(new SimpleDateFormat("yyyyMMdd"), true);
binder.registerCustomEditor(Data.class, editor);
}
5.@ControllerAdvice、@ExceptionHandler、@ResponseStatus
@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用,主要是用来处理控制器所抛出的异常信息。首先,我们需要定义一个被@ControllerAdvice所标注的类,在该类中,定义一个用于处理具体异常的方法,并使用@ExceptionHandler注解进行标记。此外,在有必要的时候,可以使用@InitBinder在类中进行全局的配置,还可以使用@ModelAttribute配置与视图相关的参数。使用@ControllerAdvice注解,就可以快速的创建统一的,自定义的异常处理类。
@ExceptionHander注解用于标注处理特定类型异常类所抛出异常的方法。当控制器中的方法抛出异常时,Spring会自动捕获异常,并将捕获的异常信息传递给被@ExceptionHandler标注的方法。
@ResponseStatus注解可以标注请求处理方法。使用此注解,可以指定响应所需要的HTTP STATUS。特别地,我们可以使用HttpStauts类对该注解的value属性进行赋值。
下面是一个使用@ControllerAdvice的示例代码
/**
* 统一异常处理类
*/
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler
@ResponseStatus(HttpStatus.BAD_REQUEST)
public BaseResponse<String> handleMethodArgumentNotValidException(MethodArgumentNotValidException exception) {
StringBuilder errorInfo = new StringBuilder();
BindingResult bindingResult = exception.getBindingResult();
for(int i = 0; i < bindingResult.getFieldErrors().size(); i++){
if(i > 0){
errorInfo.append(" ; ");
}
FieldError fieldError = bindingResult.getFieldErrors().get(i);
errorInfo.append(fieldError.getField()).append(": ").append(fieldError.getDefaultMessage());
}
//返回BaseResponse
BaseResponse<String> response = new BaseResponse<>();
response.setMsg(errorInfo.toString());
response.setCode(DefaultErrorCode.error);
return response;
}
/**
* 处理自定义异常
*/
@ExceptionHandler
@ResponseStatus(HttpStatus.BAD_REQUEST)
public BaseResponse<String> handleBaseRuntimeException(BaseRuntimeException exception) {
BaseResponse<String> response = new BaseResponse<>();
response.setMsg(exception.getMessage());
response.setCode(DefaultErrorCode.error);
return response;
}
/**
* 处理其他未知异常
*/
@ExceptionHandler
public BaseResponse<String> handleDefaultException(Exception exception) {
BaseResponse<String> response = new BaseResponse<>();
response.setMsg("未知错误");
response.setCode(DefaultErrorCode.error);
return response;
}
}
2. Spring Bean 注解
1. @ComponentScan
@ComponentScan注解用于配置Spring需要扫描的被组件注解注释的类所在的包。可以通过配置其basePackages属性或者value属性来配置需要扫描的包路径。value属性是basePackages的别名。
@Configuration
@ComponentScan(basePackages="com.jun.cloud")
public class ComponentScanConfiug {
}
2. @Component、@Service、@Repository
@Component注解用于标注一个普通的组件类,它没有明确的业务范围,只是通知Spring被此注解的类需要被纳入到Spring Bean容器中并进行管理。@Controller、@Service、@Repository都是@Component的延伸
3. @Configuration、@Bean
用于进行springboot的配置,如:
@Configuration
@EnableAsync//开启异步任务的支持
public class TaskExecutorConfig {
@Bean
public TaskExecutor threadPoolTaskExecutor() {
ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
//如果池中的实际线程数小于corePoolSize,无论是否其中有空闲的线程,都会给新的任务产生新的线程
taskExecutor.setCorePoolSize(5);
//连接池中保留的最大连接数。
taskExecutor.setMaxPoolSize(15);
//queueCapacity 线程池所使用的缓冲队列
taskExecutor.setQueueCapacity(6000);
//建议一定要给线程起一个有意义的名称前缀,便于分析日志
taskExecutor.setThreadNamePrefix("demo Thread-");
taskExecutor.initialize();
return taskExecutor;
}
}
4. @Scope
@Scope所限定的作用范围有:singleton、prototype、request、session、globalSession或者其他的自定义范围。在定义一个Bean时,可以设置Bean的scope属性为prototype:scope=“prototype”
,也可以使用@Scope注解设置,如下:
@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)
当@Scope的作用范围设置成Singleton时,被此注解所标注的类只会被Spring IoC容器初始化一次。在默认情况下,Spring IoC容器所初始化的类实例都为singleton。
5. @Primary、@PostConstruct与@PreDestroy
5.@Autowired、@Qualifier、@Resource
@Resource(这个注解其实是属于J2EE的),默认安装名称进行装配,@Autowired默认按类型装配。他们的区别可以查看@Autowired和@Resource的区别。
3. spingboot注解
1. @SpringBootApplication
@SpringBootApplication注解是一个快捷的配置注解。此注解相当于@Configuration、@EnableAutoConfiguration和@ComponentScan的组合。在Spring Boot应用程序的主类中,就使用了此注解。示例代码如下:
@SpringBootApplication
public class CloudStartApplication {
public static void main(String[] args) {
SpringApplication.run(CloudStartApplication.class, args);
}
}
2. @EnableAutoConfiguration
3. 条件注解@ConditionalOnClass与@ConditionalOnMissingClass
这两个注解属于条件注解,它们根据是否存在某个类作为判断依据来决定是否要执行某些配置。下面是一个简单的示例代码:
@Configuration
@ConditionalOnClass(DataSource.class)
class MySQLAutoConfiguration {
//...
}
类似的还有@ConditionalOnBean与@ConditionalOnMissingBean、@ConditionalOnProperty