springboot常用注解

Posted 2022-12-06 z1427094386

springboot常用注解

• • • 1、@SpringBootApplication
    • 2、@Repository
    • 3、@Service
    • 4、@RestController
    • 5、@ResponseBody
    • 6、@Configuration
    • 7、@Bean
    • 8、@AutoWired和@Qualifier @Resource
    • 9、@RequestMapping
    • 10、@RequestParam
    • 11、@PathVariable
    • 12、异常处理 全局 自定义

1、@SpringBootApplication

包含@Configuration、@EnableAutoConfiguration、@ComponentScan 通常用在主类上。

@SpringBootApplication
public class HpApplication 
    public static void main(String[] args) 
        SpringApplication.run(HpApplication.class, args);
    

2、@Repository

用于标注数据访问组件，即DAO组件。

3、@Service

用于标注业务层组件。

@Service
public class UserService 

4、@RestController

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

@RestController
public class UserController 

5、@ResponseBody

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

    @PostMapping("/register")
    public Result<User> register(@RequestBody User user, HttpServletRequest request) )

一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，加上@responsebody后返回结果不会被解析

为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@responsebody后，会直接返回json数据。

6、@Configuration

指出该类是 Bean 配置的信息源，相当于XML中的，一般加在主类上。

7、@Bean

相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

8、@AutoWired和@Qualifier @Resource

@Autowired是自动注入，自动从spring的上下文找到合适的bean来注入
@Resource用来指定名称注入
@Qualifier和@Autowired配合使用，指定bean的名称

9、@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

该注解有六个属性：

params:指定request中必须包含某些参数值是，才让该方法处理。

headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。

value:指定请求的实际地址，指定的地址可以是URI Template 模式

method:指定请求的method类型， GET、POST、PUT、DELETE等

consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;

produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回

10、@RequestParam

用在方法的参数前面。

    @GetMapping("/page")
    public Result<List<Permission>> findPage(@RequestParam(required = false) String name) 

11、@PathVariable

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

  @DeleteMapping("/id")
  public Result<?> deleteById(@PathVariable Integer id) )

12、异常处理 全局 自定义

全局异常处理

/**
 * 配置自定义异常
 */
//这个异常发生在controller层 里面
@ControllerAdvice(basePackages="cn.zs.controller") 
public class GlobalExceptionHandler 
    private static final Log log = LogFactory.get();
    //统一异常处理@ExceptionHandler,主要用于Exception
    @ExceptionHandler(Exception.class)
    @ResponseBody//把当前信息发送到前端去  返回json串
    public Result<?> error(HttpServletRequest request, Exception e)
        log.error("异常信息：",e); 
        return Result.error("-1", "系统异常");
    
    //自定义的异常 
    @ExceptionHandler(CustomException.class)
    @ResponseBody
    public Result<?> customError(HttpServletRequest request, CustomException e)
        return Result.error(e.getCode(), e.getMsg()); 
    

/**
 * 自定义异常 他继承于 RuntimeException运行时异常
 */
public class CustomException extends RuntimeException 
    private String code;
    private String msg;
    //set get方法 及构造方法