SpringBoot常用注解

最新推荐文章于 2024-07-25 17:03:24 发布

喜欢晒网的打鱼人

最新推荐文章于 2024-07-25 17:03:24 发布

阅读量681

点赞数 1

本文链接：https://blog.csdn.net/m0_57485150/article/details/128325161

版权

@EnableAutoConfiguration

@ComponentScan

@SpringBootApplication

@EnableCaching

@value

@ConfigurationProperties

@Conditional

数据库事务相关注解

@EnableTransactionManagement

@Transactional

SpringSecurity相关注解

@EnableWebSecurity

@EnableGlobalMethodSecurity

组件相关注解

@Controller

用于修饰MVC中controller层的组件，SpringBoot中的组件扫描功能会识别到该注解，并为修饰的类实例化对象，通常与@RequestMapping联用，当SpringMVC获取到请求时会转发到指定路径的方法进行处理。

@Controller
@RequestMapping("/admin")
public class UmsAdminController {
    
}

@Service

用于修饰service层接口实现类的组件，service层组件专注于系统业务逻辑的处理，同样会被组件扫描并生成实例化对象。

@Service
public class UmsAdminServiceImpl implements UmsAdminService {
    
}

@Repository

用于修饰dao层的组件，dao层组件专注于系统数据的处理，例如数据库中的数据，同样会被组件扫描并生成实例化对象。

@Repository
public interface UmsAdminRoleRelationDao {
    
}

@Component

用于修饰SpringBoot中的组件，会被组件扫描并生成实例化对象。其实像@Controller、@Service、@Repository本质都是@Component，只是这几个注解用来方便区分不同层的实例化对象。

@Component
public class CancelOrderSender {
    
}

依赖注入相关注解

@Autowired

当某一个Bean对象需要依赖另外一个Bean对象的时候可以使用这个注解注入，它会根据对象的类型自动注入依赖对象，默认要求注入对象实例必须存在，可以配置required=false来注入不一定存在的对象。

@Controller
@RequestMapping("/admin")
public class UmsAdminController {
    //这里需要一个UmsAdminService对象，可以使用@Autowired注解注入
    @Autowired
    private UmsAdminService adminService;
}

@Qualifier

当同一个对象有多个实例可以注入时，使用@Autowired注解无法进行注入，这时可以使用@Qualifier注解指定实例的名称进行精确注入。配合@Autowired注解根据实例的名称进行Bean对象的注入。

@Controller
@RequestMapping("/admin")
public class UmsAdminController {
    //注入UmsAdminService类型，名字为umsAdminServiceImpl的Bean对象
    @Autowired
    @Qualifier("umsAdminServiceImpl")
    private UmsAdminService adminService;
}

这个注解也可以放在方法上，指定这个方法内的adminServiceBean对象是哪个。

@Component // 加注解，让spring识别
@Qualifier("teacherPeople") //指定bean对象名字
public class Teacher implements People{

    @Override
    public String sing(String str) {
        return "I am teacher: "+str;
    }
}


@Component // 加注解，让spring识别
@Qualifier("studentPeople")  //指定bean对象名字
public class Student implements People{
    @Override
    public String sing(String str) {
        return "I am student: "+str;
    }
}



@Service
public class PeopleService {
    private static final Logger logger = LoggerFactory.getLogger(PeopleService .class);

    @Autowired   //根据类型引入Bean对象，但是这个类型有两个实例Bean
    private People people;

    @Qualifier("studentPeople")   //在方法上通过注解去指定使用哪一个。
    public String sing(){
        return people.sing("song 857");
    }
}

@Resource

默认会根据对象的名称自动注入依赖对象，如果想要根据类型进行注入，可以设置属性为type = UmsAdminService.class。

@Controller
@RequestMapping("/admin")
public class UmsAdminController {
    //@Resource注解如果不指定name属性，首先会默认将类的成员属性名当作Bean对象名字去找，如果找不到就会根据类型去找。
    //如果没指定的属性会有默认值，然后降低要求去找，如果指定了名字属性和类型属性，又不存在这个名字或者这个类型的Bean对象就会报错。
    @Autowired
    @Resource(name = "umsAdminServiceImpl")
    private UmsAdminService adminService;
}

实例与生命周期相关注解

@Bean

用于修饰方法，标识该方法会创建一个Bean实例，并交给Spring容器来管理，一般放在配置类中使用。

@Configuration
public class RestTemplateConfig {
    //创建一个Bean对象，类型是RestTemplate，名字为方法名restTemplate
    @Bean
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}

@Scope

用于声明一个SpringBean实例的作用域，作用域的范围有以下几种：

singleton：单例模式，在Spring容器中该实例唯一，Spring默认的实例模式。
prototype：原型模式，每次使用实例都将重新创建。
request：在同一请求中使用相同的实例，不同请求重新创建。
session：在同一会话中使用相同的实例，不同会话重新创建。
global session：portlet应用中专用，如果再Servlet的WEB应用中使用，作用和session一样。
application：一个应用对应一个Bean，仅限与WEB应用中使用。
websocket：一个websocket生命周期对应一个Bean，仅限与WEB应用中使用。
自定义scope：比较少使用（使用方法就不在这里演示了）。

@Configuration
public class RestTemplateConfig {
    @Bean
    @Scope("singleton")
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}

@Primary

当同一个对象有多个实例时，优先选择该实例。例如一个接口有多个实现类，别的地方通过接口类型去引入依赖，但是这个类型下有两个实例Bean，该引用哪一个呢？就可以在对应的实现类上或者@Bean创建的对象上使用这个注解，设置优先选择。(也可以通过@Qualifier实现这个需求)

@Configuration
public class JacksonConfig {
    @Bean
    @Primary
    @ConditionalOnMissingBean(ObjectMapper.class)
    public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
        ObjectMapper objectMapper = builder.createXmlMapper(false).build();
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        return objectMapper;
    }
}

@PostConstruct

用于修饰方法，当对象实例被创建并且依赖注入完成后执行，可用于对象实例的初始化操作。

@PreDestroy

用于修饰方法，当对象实例将被Spring容器移除时执行，可用于对象实例持有资源的释放。

//@PostConstruct、@PreDestroy示例:
public class DynamicSecurityMetadataSource implements FilterInvocationSecurityMetadataSource {

    private static Map<String, ConfigAttribute> configAttributeMap = null;
    @Autowired
    private DynamicSecurityService dynamicSecurityService;

    //实例对象完成创建并依赖注入完成后会执行这个方法
    @PostConstruct
    public void loadDataSource() {
        configAttributeMap = dynamicSecurityService.loadDataSource();
    }


    //实例对象被spring容器移除时会执行这个方法
    @PreDestroy
    public void clearDataSource() {
        configAttributeMap.clear();
        configAttributeMap = null;
    }
}

SpringMVC相关注解

@RequestMapping

可用于将Web请求路径映射到处理类的方法上，当作用于类上时，可以统一类中所有方法的路由路径，当作用于方法上时，可单独指定方法的路由路径。

method属性可以指定请求的方式，如GET、POST、PUT、DELETE等。

@RequestBody

表示方法的请求参数为JSON格式，从Body中传入，将自动绑定到方法参数对象中。

@ResponseBody

表示方法将返回JSON格式的数据，会自动将返回的对象转化为JSON数据。

@RestController

有一个集合@Controller和@ResponseBody注解的合成注解——@RestController注解，这个注解用在Controller类上，表示这个类的所有方法都是自动返回的对象转化成JSON数据。使用了@RestController就不需要@Controller和@ResponseBody了。

@RestController
@RequestMapping("/admin")
public class UmsAdminController {

    //因为类上用了RestController，所以不用@ResponseBody
    @RequestMapping(value = "/testRestController", method = RequestMethod.GET)
    public CommonResult<UmsAdmin> getItem(@PathVariable Long id) {
        UmsAdmin admin = adminService.getItem(id);
        return CommonResult.success(admin);
    }

}

@RequestParam

用于接收请求参数，可以是如下三种形式：

query param：GET请求拼接在地址里的参数。
form data：POST表单提交的参数。
multipart：文件上传请求的部分参数。

@PathVariable

用于接收请求路径中的参数，常用于REST风格的API。

//@RequestMapping、@RequestBody、@ResponseBody、@RequestParam、@PathVariable使用
@Controller
@RequestMapping("/admin")
public class UmsAdminController {

    @RequestMapping(value = "/register", method = RequestMethod.POST)
    @ResponseBody
    public CommonResult<UmsAdmin> register(@RequestBody UmsAdminParam umsAdminParam) {
        UmsAdmin umsAdmin = adminService.register(umsAdminParam);
        if (umsAdmin == null) {
            return CommonResult.failed();
        }
        return CommonResult.success(umsAdmin);
    }
    
    @RequestMapping(value = "/list", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult<CommonPage<UmsAdmin>> list(@RequestParam(value = "keyword", required = false) String keyword,
                                                   @RequestParam(value = "pageSize", defaultValue = "5") Integer pageSize,
                                                   @RequestParam(value = "pageNum", defaultValue = "1") Integer pageNum) {
        List<UmsAdmin> adminList = adminService.list(keyword, pageSize, pageNum);
        return CommonResult.success(CommonPage.restPage(adminList));
    }

    //REST风格的API  /{}
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult<UmsAdmin> getItem(@PathVariable Long id) {
        UmsAdmin admin = adminService.getItem(id);
        return CommonResult.success(admin);
    }
}

@RequestPart

用于接收文件上传中的文件参数，通常是multipart/form-data形式传入的参数。

@Controller
@RequestMapping("/fileUpLoad")
public class FileUpLoadController {

    @RequestMapping(value = "/upload", method = RequestMethod.POST)
    @ResponseBody
    public CommonResult upload(@RequestPart("file") MultipartFile file) {
            //此处执行文件上传操作...
    }
}

@GetMapping

用于表示GET请求方法，等价于@RequestMapping(method = RequestMethod.GET)。

@PostMapping

用于表示POST请求方法，等价于@RequestMapping(method = RequestMethod.POST)。

配置相关注解

@Configuration

用于声明一个Java形式的配置类，SpringBoot推荐使用Java配置，在该类中声明的Bean等配置将被SpringBoot的组件扫描功能扫描到。

@Configuration
//在SpringBoot主启动类上的注解也可以放在配置类中，也会生效，例如下面的@MapperScan
//多个包路径，使用{"","","",""}
@MapperScan({"com.wangkaiping","exe.xxxx"})
public class MyBatisConfig {
}

@EnableAutoConfiguration

启用SpringBoot的自动化配置，会根据你在pom.xml添加的依赖和application-dev.yml中的配置自动创建你需要的配置。

@Configuration
@EnableAutoConfiguration
public class AppConfig {
}

@ComponentScan

启用SpringBoot的组件扫描功能，扫描指定的包内的所有类，将自动装配加了@Component注解的Bean实例。

@Configuration
//多个包路径，使用{"","","",""}
@ComponentScan({"com.wangkaiping","exe.xxxx"})
public class EruptConfig {
}

@SpringBootApplication

用于表示SpringBoot应用中的启动类，相当于@SpringBootConfiguration、@EnableAutoConfiguration和@ComponentScan三个注解的结合体。

@EnableCaching

当添加Spring Data Redis依赖之后，可用该注解开启Spring基于注解的缓存管理功能。

@EnableCaching
@Configuration
public class RedisConfig {

}

@value

用于注入在配置文件中配置好的属性，例如我们可以在application.yml配置如下属性：

jwt:
  tokenHeader: Authorization #JWT存储的请求头
  secret: mall-admin-secret #JWT加解密使用的密钥
  expiration: 604800 #JWT的超期限时间(60*60*24*7)
  tokenHead: 'Bearer '  #JWT负载中拿到开头

然后在Java类中就可以使用@Value注入并进行使用了。

//想要获取配置文件的值，需要加Component注解，表示创建实例对象给spring容器管理。
@Component
public class JwtTokenUtil {
    @Value("${jwt.secret}")
    private String secret;
    @Value("${jwt.expiration}")
    private Long expiration;
    @Value("${jwt.tokenHead}")
    private String tokenHead;
}

@ConfigurationProperties

用于批量注入外部配置，以对象的形式来导入指定前缀的配置，比如这里我们在application.yml中指定了secure.ignored为前缀的属性：

secure:
  ignored:
    urls: #安全路径白名单，-表示是一个数组的元素
      - /swagger-ui/
      - /swagger-resources/**
      - /**/v2/api-docs
      - /**/*.html
      - /**/*.js
      - /**/*.css
      - /**/*.png
      - /**/*.map
      - /favicon.ico
      - /actuator/**
      - /druid/**

@Configuration
//指定属性的前缀，和yml文件中的配置对应
@ConfigurationProperties(prefix = "secure.ignored")
public class IgnoreUrlsConfig {
    //前缀拼接 . + 属性名的到的路径,就是yml文件该路径配置的值。
    private List<String> urls = new ArrayList<>();

}

@Conditional

用于表示当某个条件满足时，该组件或Bean将被Spring容器创建，下面是几个常用的条件注解。

@ConditionalOnBean：当某个Bean存在时，配置生效。
@ConditionalOnMissingBean：当某个Bean不存在时，配置生效。
@ConditionalOnClass：当某个类在Classpath存在时，配置生效。
@ConditionalOnMissingClass：当某个类在Classpath不存在时，配置生效。

@Configuration
public class JacksonConfig {
    @Bean
    //当类路径下没有ObjectMapper这个类的时候这个生效。
    @ConditionalOnMissingBean(ObjectMapper.class)
    public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
        ObjectMapper objectMapper = builder.createXmlMapper(false).build();
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        return objectMapper;
    }
}

数据库事务相关注解

@EnableTransactionManagement

启用Spring基于注解的事务管理功能，需要和@Configuration注解一起使用。

@Configuration
@EnableTransactionManagement
@MapperScan({"com.wangkaiping","exe.xxxx"})
public class MyBatisConfig {
}

@Transactional

表示方法和类需要开启事务，当作用与类上时，类中所有方法均会开启事务，当作用于方法上时，方法开启事务，方法上的注解无法被子类所继承。

public class OmsPortalOrderServiceImpl implement OmsPortalOrderService {

    /**
     * 根据提交信息生成订单
     * 不管@Transactional注解是在类上或实现类的方法上还是在接口上或接口方法上，它的事务功            能都是可以实现的，只是选择那种方式更优雅一点而已。
     * Spring官方建议在具体的类或类的方法上使用@Transactional注解，而不是在接口或接口方法上使用。@Transactional也可以在接口上使用，但是这仅限于你使用的是基于接口的动态代理。在java中注解是不会被继承的，如果使用的是基于类的动态代理或者使用aspectj，@Transactional注解的作用就失效了。
     */
    @@Override
    @Transactional
    Map<String, Object> generateOrder(OrderParam orderParam){

    }
}

SpringSecurity相关注解

@EnableWebSecurity

启用SpringSecurity的Web功能。

@EnableGlobalMethodSecurity

启用SpringSecurity基于方法的安全功能，当我们使用@PreAuthorize修饰接口方法时，需要有对应权限的用户才能访问。

@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfig{
    
}

全局异常处理注解

@ControllerAdvice

常与@ExceptionHandler注解一起使用，用于捕获全局异常，能作用于所有controller中。

@ExceptionHandler

修饰方法时，表示该方法为处理全局异常的方法。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ResponseBody
    //抛ApiException异常，走这个方法
    @ExceptionHandler(value = ApiException.class)
    public CommonResult handle(ApiException e) {
        //执行相关代码返回错误和提示。
        if (e.getErrorCode() != null) {
            return CommonResult.failed(e.getErrorCode());
        }
        return CommonResult.failed(e.getMessage());
    }
}

AOP相关注解

@Aspect

用于定义切面，切面是通知和切点的结合，定义了何时、何地应用通知功能。

@Before

表示前置通知（Before）前置通知定义方法有一个参数value="" 是切入点表达式，通知方法会在目标方法调用之前执行，通知描述了切面要完成的工作以及何时执行。

@AfterReturning

表示返回通知（AfterReturning），后置通知定义方法，有两个参数，一个value="" 是切入点表达式，另一个是returning="在后置方法中的参数名"，这个参数是目标方法的返回值，目标类方法有返回值的时候用通知方法会在目标方法返回后执行。

@AfterThrowing

表示异常通知（AfterThrowing），通知方法会在目标方法返回后执行。

@After

表示后置通知（After），通知方法会在目标方法返回或抛出异常后执行。

@Around

表示环绕通知（Around），通知方法会将目标方法封装起来，在目标方法调用之前和之后执行自定义的行为。环绕通知经常做事务，在目标方法之前开启事务，方法执行，提交事务，范围最大，前环绕在前置（Before）之前，后环绕在后置（AfterReturning）和最终通知之后。

@Pointcut

定义切点表达式，定义了通知功能被应用的范围。

@Order

用于定义组件的执行顺序，在AOP中指的是切面的执行顺序，value属性越低优先级越高。

@Aspect
@Component
@Order(1)
public class WebLogAspect {
    private static final Logger LOGGER = LoggerFactory.getLogger(WebLogAspect.class);

    @Pointcut("execution(public * com.macro.mall.tiny.controller.*.*(..))")
    public void webLog() {
    }

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
    }

    @AfterReturning(value = "webLog()", returning = "ret")
    public void doAfterReturning(Object ret) throws Throwable {
    }

    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        WebLog webLog = new WebLog();
        //省略日志处理操作...
        Object result = joinPoint.proceed();
        LOGGER.info("{}", JSONUtil.parse(webLog));
        return result;
    }
    
}

测试相关注解

@SpringBootTest

用于指定测试类启用Spring Boot Test功能，默认会提供Mock环境。

@Test

指定方法为测试方法。

@SpringBootTest
public class FirstTest {
    @Test
    public void test() {
        int a=1;
        Assertions.assertEquals(1,a);
    }
}

喜欢晒网的打鱼人

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
1
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫