SpringBoot——常用注解

Spring Web MVC与Spring Bean注解

@Controller/@RestController

@Controller是@Component注解的一个延伸，Spring 会自动扫描并配置被该注解标注的类。此注解用于标注Spring MVC的控制器。

@Controller
@RequestMapping("/api/v1")
public class UserApiController{@Autowiredprivate UserService userService;@GetMapping("/users/{id}")@ResponseBodypublic User getUserById(@PathVariable long id) throws UserNotFoundException{return userService.findOne(id);}
}

@RestController是在Spring 4.0开始引入的，这是一个特定的控制器注解。此注解相当于@Controller和@ResponseBody的快捷方式。
当使用此注解时，不需要再在方法上使用@ResponseBody注解。
将控制器方法的返回值转换为JSON格式，并以HTTP响应的方式返回给客户端。如果需要返回XML格式的响应，可以使用其他注解，如@Produces和@Consumes

@RestController
@RequestMapping("/api/v1")
public class UserApiController{@Autowiredprivate UserService userService;@GetMapping("/users/{id}")public User getUserById(@PathVariable long id) throws UserNotFoundException{return userService.findOne(id);}
}

@RequestMapping

对请求处理类中的请求处理方法进行标注，主要用途是将Web请求与请求处理类中的方法进行映射。
Spring MVC和Spring WebFlux都通过RquestMappingHandlerMapping和RequestMappingHndlerAdapter两个类来提供对@RequestMapping注解的支持

  • value:映射的请求URL或者其别名
  • method:兼容HTTP的方法名
  • params:根据HTTP参数的存在、缺省或值对请求进行过滤
  • header:根据HTTP Header的存在、缺省或值对请求进行过滤
  • consume:设定在HTTP请求正文中允许使用的媒体类型
  • product:在HTTP响应体中允许使用的媒体类型

【提示：在使用@RequestMapping之前，请求处理类还需要使用@Controller或@RestController进行标记】

@Controller
public class DemoController{@RequestMapping(value="/demo/home",method=RequestMethod.GET)public String home(){return "/home";}
}

@RequestMapping还可以对类进行标记，这样类中的处理方法在映射请求路径时，会自动将类上@RequestMapping设置的value拼接到方法中映射路径之前，如下：

@Controller
@RequestMapping(value="/demo")
public class DemoController{@RequestMapping(value="/home",method=RequestMethod.GET)public String home(){return "/home";}
}

@RequestBody

在处理请求方法的参数列表中使用，它可以将请求主体中的参数绑定到一个对象中，请求主体参数是通过HttpMessageConverter传递的，根据请求主体中的参数名与对象的属性名进行匹配并绑定值。此外，还可以通过@Valid注解对请求主体中的参数进行校验。

@RequestController
@RequestMapping("/api/v1")
public class UserController{@Autowiredprivate UserService userService;@PostMapping("/users")public User createUser(@Valid @RequestBody User user){return userService.save(user);}
}

@ResponseBody

会自动将控制器中方法的返回值写入到HTTP响应中.
@ResponseBody注解只能用在被@Controller注解标记的类中。如果在被@RestController标记的类中，则方法不需要使用@ResponseBody注解进行标注。@RestController相当于是@Controller和@ResponseBody的组合注解

@ResponseBody
@GetMapping("/users/{id}")
public User findByUserId(@PathVariable long id) throws UserNotFoundException{User user = userService.findOne(id);return user;
}

@PathVariable

将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping注解来指定URI的模板变量，然后使用@PathVariable注解将方法中的参数绑定到模板变量上。
@PathVariable注解允许我们使用value或name属性来给参数取一个别名

模板变量名需要使用{ }进行包裹，如果方法的参数名与URI模板变量名一致，则在@PathVariable中就可以省略别名的定义。

@GetMapping("/uers/{id}/roles/{roleId}")
public Role getUserRole(@PathVariable(name="id") long id,@PathVariable(value="roleId")long roleId)throws ResourceNotFoundException{return userRoleService.findByUserIdAndRoledId(id,roleId);
}

@RequestParam

用于将方法的参数与Web请求的传递的参数进行绑定。
使用@RequestParam可以轻松的访问HTTP请求参数的值
该注解的其他属性配置与@PathVariable的配置相同，特别的，如果传递的参数为空，还可以通过defaultValue设置一个默认值。

@GetMapping
public Role getUserRole(@RequestParam(name="id") long id,@ReuqestParam(name="roleId")long roleId)throws ResourceNotFoundException{return userRoleService.findByUserIdAndRoleId(id,roleId);
}//如果参数为空设置默认值
@GetMapping
public Role getUserRole(@RequestParam(name="id",defalut="0") long id,@RequestParam(name="roleId",default="0")long roleId){if(id==0||roleId==0){return new Role();}return userRoleService.findByUserIdAndRoleId(id,roleId);
}

@ModelAttribute

通过此注解，可以通过模型索引名称来访问已经存在于控制器中的model。
与@PathVariable和@RequestParam注解一样，如果参数名与模型具有相同的名字，则不必指定索引名称

@PostMapping("/users")
public void createUser(@ModelAttribute("user") User user){userService.save(user);
}

如果使用@ModelAttribute对方法进行标注，Spring会将方法的返回值绑定到具体的Model上。

@ModelAttribute("ramostear")
User getUser(){User user = new User();user.setId(1);user.setFirstName("ramostear");user.setEmail("ramostear@163.com");return user;
}

【在Spring调用具体的处理方法之前，被@ModelAttribute注解标注的所有方法都将被执行。】

@GetMapping/@PostMapping/@PutMapping/@DeleteMapping@PatchMapping

用于处理HTTP GET/POST/PUT/DELETE/PATCH请求，并将请求映射到具体的处理方法中。具体来说，@GetMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.GET/POST/PUT/DELETE/PATCH)的快捷方式

@RequestController
@RequestMapping("/api/v1")
public class UserController{@Autowiredprivate UserService userService;@GetMapping("/users")public List<User> findAllUser(){List<User> users = userService.findAll();return users;}@GetMapping("/users/{id}")public User findOneById(@PathVariable(name="id") long id) throws UserNotFoundException{return userService.findOne();}@PostMapping("/users")public User createUser(@Valid @RequestBody User user){return userService.save(user);}@PutMapping("/users/{id}")public ResponseEntity<User> updateUser(@PathValriable(name="id") long id,@Value @ResponseBody User detail)throws UserNotFoundException{User user = userRepository.findById(id).orElseThrow(() -> UserNotFoundException("User not found with this id "+id));user.setLastName(detail.getLastName());user.setEmail(detail.getEmail());user.setAddress(detail.getAddress());final User origin = userRepository.save(user);return ResponseEntity.ok(origin);}@DeleteMapping("/users/{id}")public Map<String,Boolean> deleteById(@PathVariable(name="id") long id) throws UserNotFoundException{User user = userRepository.findById(id).orElseThrow(() -> UserNotFoundException("User not found with this id "+id));userRepository.delete(user);Map<String,Boolean> response = new HashMap<>();response.put("deleted",Boolean.TRUE);return response;}@PatchMapping("/users/patch")public ResponseEntity<Object> patch(){return new ResponseEntity<>("Path method response message",HttpStatus.OK);}
}

@ControllerAdvice

@ControllerAdvice是@Component注解的一个延伸注解，Spring会自动扫描并检测被@ControllerAdvice所标注的类。
@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用，主要是用来处理控制器所抛出的异常信息。

我们需要定义一个被@ControllerAdvice所标注的类，在该类中，定义一个用于处理具体异常的方法，并使用@ExceptionHandler注解进行标记。
在有必要的时候，可以使用@InitBinder在类中进行全局的配置，还可以使用@ModelAttribute配置与视图相关的参数。
使用@ControllerAdvice注解，就可以快速的创建统一的，自定义的异常处理类。

@ControllerAdvice(basePackages={"com.ramostear.controller.user"})
public class UserControllerAdvice{@InitBinderpublic void binder(WebDataBinder binder){SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");format.setLenient(false);binder.registerCustomEditor(Date.class,"user",new CustomDateFormat(format,true));}//配置于视图相关的参数@ModelAttributepublic void modelAttribute(Model model){model.addAttribute("msg","User not found exception.");}@ExceptionHandler(UserNotFoundException.class)public ModelAndView userNotFoundExceptionHandler(UserNotFoundException e){ModelAndView modelAndView = new ModelAndView();modelAndView.addObject("exception",ex);modelAndView.setViewName("error");return modelAndView;}
}

@ExceptionHander注解用于标注处理特定类型异常类所抛出异常的方法。
当控制器中的方法抛出异常时，Spring会自动捕获异常，并将捕获的异常信息传递给被@ExceptionHandler标注的方法。

@ExceptionHandler(UserNotFoundException.class)
public ResponseEntity<Object> userNotFoundExceptionHandler(UserNotFoundException ex,WebRequest request){UserErrorDetail detail = new UserErrorDetail(new Date(),ex.getMessage,request.getDescription(false));return new ResponseEntity<>(detail,HttpStates.NOT_FOUND);
}

@InitBinder注解用于标注初始化WebDataBinider 的方法，该方法用于对Http请求传递的表单数据进行处理，如时间格式化、字符串处理等。

@InitBinder
public void initBinder(WebDataBinder dataBinder){StringTrimmerEditor editor = new StringTrimmerEditor(true);dataBinder.registerCustomEditor(String.class,editor);
}

@ResponseStatus

标注请求处理方法。使用此注解，可以指定响应所需要的HTTP STATUS。特别地，我们可以使用HttpStauts类对该注解的value属性进行赋值。

@ResponseStatus(HttpStatus.BAD_REQEST)
@ExceptionHandler(UserNotFoundException.class)
public ResponseEntity<Object> userNotFoundExceptionHandler(UserNotFoundException ex,WebRequest request){UserErrorDetail detail = new UserErrorDetail(new Date(),ex.getMessage(),request.getDescription(false));return new ResponseEntity<>(detail,HttpStatus.NOT_FOUND);
}

@CrossOrigin

解决跨域问题，跨域资源共享（CORS）问题。跨域资源共享是浏览器安全策略的一部分，它限制了浏览器在不同域名之间发送和接收HTTP请求。

/**使用@CrossOrigin注解指定允许来自http://localhost:8080域名的GET和POST请求访问该控制器中的方法。这意味着，在http://localhost:8080域名下的网页可以通过XMLHttpRequest对象发送GET和POST请求，访问该控制器中的方法
*/
@RequestController
@RequestMapping("/api")
@CrossOrigin(origins="http://localhost:8080",methods={RequestMethod.GET,RequestMethod.POST})
public class ApiController{@GetMapping("/users")public List<User> getUsers(){//查询用户信息List<User> users = userService.getUsers();return users;}
}

@Async

在Spring框架中，如果一个方法需要执行一些比较耗时的操作，如果这个方法是在主线程中执行，就会导致主线程被阻塞，用户界面无法响应用户的操作。使用@Async注解可以将这个方法的执行异步化，让主线程继续执行其他任务，提高应用程序的响应性能。

@Service
public class UserService{//查询用户信息的操作在异步线程中执行，不会阻塞主线程。@Asyncpublic CompletableFuture<UserDetails> getUserDetailsAsync(Long id){// 查询用户信息UserDetails userDetails = userRepository.getUserDetails(id);return CompletableFuture.completedFuture(userDetails);//返回一个CompletableFuture对象，表示异步执行的结果}
}

@Cacheable

在Spring框架中，如果一个方法的返回结果是固定的，而且这个方法的执行比较耗时，我们可以使用@Cacheable注解将这个方法的返回结果缓存起来，下次执行这个方法时直接从缓存中获取结果，避免重复执行

@Service
public class UserServie{//这个方法的返回结果可以被缓存起来,会被缓存到名为"userCache"的缓存中@Cacheable("userCache")public User getUser(Long id){// 查询用户信息User user = userRepository.getUser(id);return user;}
}

@CacheEvict

在Spring框架中，如果一个方法的执行会导致缓存数据的失效，我们可以使用@CacheEvict注解将这个方法的缓存数据清空，这样下次执行这个方法时就会重新查询数据并缓存起来。

@Service
public class UserService{@Cacheable("userCache")public User getUser(Long id){// 查询用户信息User user = userRepository.getUser(id);return user;}//当调用clearCache方法时，@CacheEvict注解会清空名为"userCache"的缓存，下次执行getUser方法时，就需要重新查询数据并缓存起来@CacheEvict("userCache")public void clearCache(){//清空缓存}
}

@CachePut

在Spring框架中，如果一个方法的执行会导致缓存数据的更新或添加，我们可以使用@CachePut注解将这个方法的返回结果更新或添加到缓存中

@Service
public class UserService {@Cacheable("userCache")public User getUser(Long id) {// 查询用户信息User user = userRepository.getUser(id);return user;}/**调用updateUser方法时，@CachePut注解会更新或添加名为"userCache"的缓存，下次执行getUser方法时，就可以从缓存中获取更新后的用户信息*/@CachePut("userCache")public User updateUser(Long id, User user) {// 更新用户信息User updatedUser = userRepository.updateUser(id, user);return updatedUser;}
}

@Transactional

在Spring框架中，如果一个方法需要对数据库进行操作，我们可以使用@Transactional注解来确保这个操作在一个事务中进行，从而保证操作的原子性、一致性、隔离性和持久性

/**在类级别上使用@Transactional注解标注，表示这个类中的所有方法都需要使用事务进行操作
*/
@Service
@Transactional
public class UserService {@Autowiredprivate UserRepository userRepository;//userRepository的操作都在一个事务中进行public void createUser(User user) {userRepository.save(user);}public void updateUser(Long id, User user) {User existingUser = userRepository.findById(id);if (existingUser != null) {existingUser.setName(user.getName());existingUser.setEmail(user.getEmail());userRepository.save(existingUser);}}
}

@EnableAspectJAutoProxy

用于启用自动代理功能，以便使用AOP（面向切面编程）进行编程

/**在类级别上使用@EnableAspectJAutoProxy注解标注，表示这个配置类需要启用自动代理功能。
*/
@Configuration
@EnableAspectJAutoProxy
public class AppConfig{@Beanpublic MyAspect myAspect(){return new MyAspect();}@Beanpublic UserService userService(){return new UserService();}
}

@Aspect/@Pointcut

@Aspect用于标识一个类为切面类，从而可以在该类中定义切面逻辑以实现AOP（面向切面编程）
在切面类中，我们可以定义切面逻辑，包括切入点、通知类型和切面顺序等
@Pointcut定义一个切入点，从而可以在该切入点上定义通知类型以实现AOP

@Aspect
@Component
public class MyAspect{@Before("execution(* com.michael.UserService.*(..))")public void beforeAdvice(){System.out.println("Before advice is executed.");}@After("execution(* com.example.UserService.*(..))")public void afterAdvice() {System.out.println("After advice is executed.");}
}

@Aspect
@Component
public class MyAspect{@Pointcut("execution(* com.michael.UserService.*(..))")public void userServicePointcut(){}@Before("userServicePointcut()")public void beforeAdvice() {System.out.println("Before advice is executed.");}@After("userServicePointcut()")public void afterAdvice() {System.out.println("After advice is executed.");}
}

@Order

如果有多个切面类需要对同一个方法进行切面处理，那么这些切面类的执行顺序可能会影响到最终的结果。为了控制这些切面类的执行顺序，我们可以使用@Order注解来定义它们的执行顺序，参数为一个整数，数值越小表示优先级越高，数值相同时按照类名的自然顺序进行排序

@Aspect
@Component
@Order(1)
public class MyAspect1{@Before("execution(* com.example.UserService.*(..))")public void beforeAdvice() {System.out.println("Before advice from MyAspect1 is executed.");}
}@Aspect
@Component
@Order(2)
public class MyAspect2 {@Before("execution(* com.example.UserService.*(..))")public void beforeAdvice() {System.out.println("Before advice from MyAspect2 is executed.");}
}

@Slf4j

是Lombok框架中的一个注解，用于在Java类中自动生成日志记录器
通常情况下，我们需要手动引入日志框架（如Log4j、SLF4J等）并编写相应的日志记录代码。这些代码可能会比较繁琐，而且容易出现错误。为了简化这个过程，Lombok框架提供了一个@Slf4j注解，可以在Java类中自动生成日志记录器。

@Slf4j
public class MyService{/**使用log变量来记录日志，而不需要再引入其他的日志框架*/public void doSomething(){log.debug("This is a debug message.");log.info("This is an info message.");log.error("This is an error message.");}
}

==========================================================

SpringBean相关的注解

@ComponentScan

@ComponentScan注解用于配置Spring需要扫描的被组件注解注释的类所在的包。可以通过配置其basePackages属性或者value属性来配置需要扫描的包路径。
value属性是basePackages的别名。

@Configuration
@ComponentScan(basePackages="com.michael.service")
public class ServiceConfig{}

@Component与@Value

@Component用于标注一个普通的组件类，它没有明确的业务范围，只是通知Spring被此注解的类需要被纳入到Spring Bean容器中并进行管理。
@Value用于获取配置文件中的属性值，将配置文件中的属性值注入到Bean对象中。方便地处理不同环境下的配置文件，如开发环境和生产环境的配置文件

@Component
public class EncryptUserPasswordComponent{@Value("${my.property}")private String myProperty;public String encrypt(String password,String salt){}
}

@Profile

用于指定配置环境，如开发环境、测试环境或生产环境

@Configuration
public class AppConfig{@Bean@Profile("dev")public UserService userServiceDev(){return new UserServiceDevImpl();}@Bean@PProfile("prod")public UserService usserServiceProd(){return new UserServiceProdImpl();}
}

@PropertySource

用于指定配置文件位置，用于指定一组属性文件的位置，从而可以在Spring应用程序中使用这些属性

@Configuration
@PropertySource("classpath:application.properties")
public class AppConfig{@Autowiredprivate Environment environment;/**使用Environment对象从属性文件中读取属性值，并将这些属性值传递给UserService实例的构造方法*/@Beanpublic UserService userService(){return new UserServiceImpl(environment.getProperty("userService.name"));}
}

@Service

@Service注解是@Component的一个延伸（特例），它用于标注业务逻辑类。与@Component注解一样，被此注解标注的类，会自动被Spring所管理。

@Repository

@Repository注解也是@Component注解的延伸，与@Component注解一样，被此注解标注的类会被Spring自动管理起来，@Repository注解用于标注DAO层的数据持久化类。

@Import

能够将额外的配置类导入到当前的配置类中。本质上，此注释有助于合并来自不同模块的配置，从而有助于模块化编程

  • 集中配置：如果您有在多个模块之间共享的配置，例如数据库或消息传递配置，您可以将它们放在单独的类中，@Configuration并在需要时将其导入到其他配置类中
  • 条件导入：Spring 的@Conditional注释可以与条件导入配置类一起使用@Import。这对于仅在特定条件下应用配置的场景非常有用，例如在不同的环境（开发、生产等）中。
@Configuration
public class DatabaseConfig{@Beanpublic DataSource dataSource(){return new DataSource();}
}

@Configuration
@Import(DatabaseConfig.class) 
public class AppConfig{@Autowiredprivate DataSource dataSource;//使用dataSource的bean
}@Configuration
@Import(DatabaseConfig.class)
@ConditionalOnProperty(name="database.enabled",havingValue="true") //条件导入
public class ConditionalAppConfig{//仅当database.enabled=true时才加载此配置
}
  • 模块化功能：如果您的应用程序具有需要各自特定配置的不同功能，您可以为每个功能创建一个配置类并将它们导入到中央配置中。这增强了可维护性和关注点分离
  • 第三方库集成：如果您使用的第三方库提供了自己的 Spring 配置，则可以使用注释将其导入到您自己的应用程序的配置中@Import
  • 对相关 Bean 进行分组：有时，如果在同一配置类中定义，逻辑上相关的 Bean 会得到更好的维护。但是，它们可以在应用程序的各个部分中使用。在这种情况下，@Import注释可以帮助您在需要的地方导入这些 bean，从而使您的应用程序保持 DRY（不要重复）

【避免循环依赖：确保您不会在配置类之间创建循环依赖，因为这会导致初始化错误
使用描述性类名称：创建配置类时，使用能够清楚表明配置用途的名称。这使得更容易理解特定配置类的作用，特别是在将其导入其他类时
文档导入：始终记录为什么需要导入，特别是在导入类和导入类之间的关系不明显的情况下。这可以通过注释或 JavaDoc 来完成
】

@ImportResource

将XML配置导入到基于注解的配置类中。当您在混合配置环境中工作或必须使用系统中不易重构的旧部分时，此注释可以成为您的救星

  • 遗留代码集成：如果您的项目已经存在了一段时间并且依赖于基于 XML 的配置，您可以将@ImportResource这些现有配置合并到更新的基于注释的配置中，而无需进行彻底修改
  • 第三方库配置：带有自己的基于 XML 的配置的库可以使用注释轻松地合并到您的应用程序中@ImportResource
  • 配置分段：在大型项目中，配置可能会变得过于广泛而无法有效管理。通过使用@ImportResource，您可以将配置分段为不同的 XML 文件，按功能或模块组织，然后根据需要导入它们。
  • 混合配置场景：有时您可能需要同时使用 XML 和基于 Java 的配置。通过注释@ImportResource，您可以无缝集成这些不同的配置类型
@Confituration
@ImportResource("classpath:com-spring-config.xml")//该some-spring-config.xml文件可以定义 bean，就像在基于XML的Spring 应用程序中一样：
public class AppConfig{//其他配置和bean
}


<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsd"><bean id="someBean" class="com.example.SomeClass"><!-- bean configurations here --></bean>
</beans>

两者区别：
@Import：该注解用于导入其他带有.注解的基于Java的配置类@Configuration
@ImportResource：此注释允许将基于 XML 的配置文件导入到基于 Java 的配置类中

===================================================

Spring Dependency Inject与Bean Scopes注解

@DependsOn

@DependsOn注解可以配置Spring IoC容器在初始化一个Bean之前，先初始化其他的Bean对象。

public class FirstBean{@Autowiredprivate SecondBean secondBean;@Autowiredprivate ThirdBean thirdBean;public FirstBean(){}
}public class SecondBean{public SecondBean(){}
}public class ThirdBean{public ThirdBean(){}
}

@Configuration
public class CustomBeanConfig{@Bean("firstBean")@DependsOn(value={"secondBean","thirdBean"})//public FirstBean firstBean(){return new FirstBean();}@Bean("secondBean")public SecondBean secondBean(){return new SecondBean();}@Bean("thirdBean")public ThireBean thirdBean(){return new ThirdBean();}
}

@Bean

主要的作用是告知Spring，被此注解所标注的类将需要纳入到Bean管理工厂中

@Component
public class DataBaseInitializer{public void init(){System.out.println("This is init method.");}public void destroy(){System.out.println("This is destroy method.");}
}

@Configuration
public class SpringBootApplicationConfig{@Bean(initMethod="init",destroyMethod="destroy")public DataBaseInitializer databaseInitializer(){return new DataBaseInitializer();}
}

@Scops

用来定义@Component标注的类的作用范围以及@Bean所标记的类的作用范围。
限定的作用范围有：singleton、prototype、request、session、globalSession或者其他的自定义范围。

当一个Spring Bean被声明为prototype（原型模式）时，在每次需要使用到该类的时候，Spring IoC容器都会初始化一个新的改类的实例。在定义一个Bean时，可以设置Bean的scope属性为prototype：scope=“prototype”,也可以使用@Scope注解设置，如下：

@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOtYPE)

两种不同的方式来使用@Scope注解

public interface UserService{}@Component
@Scope(value=ConfigurableBeanFactory.SCOPE_PROTOTYPE) //标注该类每次使用都会创建一个新对象
public class UserServiceImpl implements UserService{}@Configuration
@ComponentScan(basePackages = "com.michael.service") //扫描service包下的
public class ServiceConfig{}//------------------------------------------public class StudentService implements UserService{}@Configuration
public class StudentServiceConfig{@Bean@Scope(value=ConfigurableBeanFactory.SCOPE_PROTOTYPE)public UserService userService(){return new StudentServiceImpl();}
}

容器配置注解

@Autowired

@Autowired注解用于标记Spring将要解析和注入的依赖项。此注解可以作用在构造函数、字段和setter方法上。

@RestController
public class UserController{private UserService userService;@Autowired //作用域构造函数之上UserController(UserService userService){this.userService = userService;}@Autowired //作用域setter方法上public void setUserService(UserService userService){this.userService = userService;}@Autowired //作用域字段上private UserService userService;
}

@Primary

当系统中需要配置多个具有相同类型的bean时，@Primary可以定义这些Bean的优先级。

public interface MessageService{}@Component
public class EmailMessageServiceImpl implements MessageService{@Overridepublic String sendMessage(){return "this is send email method message";}
}@Component
public class WechatMessageImpl implements MessageService{@Overridepublic String sendMessage(){return "this is send wechat method message";}
}@Primary
@Component
public class DingDingMessageImple implements MessageService{@Overridepublic String sendMessage(){return "this is send DingDing method message";}
}//以上同一个MessageService接口类型下的三个不同实现类
@RestController
public class MessageController{@Autowiredprivate MessageService messageService;@GetMapping("/info")public String info(){return messageService.sendMessage();}
}

在这里插入图片描述

@PostConstruct与@PreDestroy

这两个注解不属于Spring,它们是源于JSR-250中的两个注解，位于common-annotations.jar中

@PostConstruct注解用于标注在Bean被Spring初始化之前需要执行的方法
@PreDestroy注解用于标注Bean被销毁前需要执行的方法。

@Component
public class DemoComponent{private List<String> list = new ArrayList<>();@PostConstructpublic void init(){list.add("jordan");list.add("kobe");}@PreDestroypublic void destroy(){list.clear();}
}

@Qualifier

当系统中存在同一类型的多个Bean时，@Autowired在进行依赖注入的时候就不知道该选择哪一个实现类进行注入。此时，我们可以使用@Qualifier注解来微调，帮助@Autowired选择正确的依赖项。

public interface MessageService{public String sendMessage(String message);
}@Service("emailService")
public class EmailServiceImpl implements MessageService{@Overridepublic String sendMessage(String message){return "send email,content:"+message;}
}@Service("smsService")
public class SMSServiceImpl implements MessageService{@Overridepublic String sendMessage(String message){return "send SMS,content"+message;}
}
public interface MessageProcessor{public String processMessage(String message);
}public class MessageProcessorImpl implements MessageProcessor{private MessageService messageService;@Autowired@Aualifier("emailService")//指定处理MessageService接口下的具体实现类public void setMessageService(MessageService messageService){this.messageServcie = messageService;}@Overridepublic String processMessage(String message){return messageService.sendMessage(message);}
}

SpringBoot注解

@SpringBootApplication

该注解是一个快捷的配置注解，在被它标注的类中，可以定义一个或多个Bean，并自动触发自动配置Bean和自动扫描组件。

此注解相当于@Configuration、@EnableAutoConfiguration和@ComponentScan的组合

  • @Configuration：指示这个类是一个配置类，它定义了一个或多个@Bean方法，用于创建和配置Spring应用程序上下文中的Bean
  • @EnableAutoConfiguration：启用Spring Boot的自动配置机制，它会自动添加所需的依赖项和配置，以使应用程序能够运行
  • @ComponentScan：指示Spring Boot扫描当前包及其子包中的所有@Component、@Service、@Repository和@Controller注解的类，并将它们注册为Spring Bean
@SpringBootApplication
public class Application{public static void main(String [] args){SpringApplication.run(Application.class,args);}
}

@EnableAutoConfiguration

该注解用于通知Spring，根据当前类路径下引入的依赖包，自动配置与这些依赖包相关的配置项

@ConditionalOnClass与@ConditionalOnMissingClass

这两个注解属于类条件注解，它们根据是否存在某个类作为判断依据来决定是否要执行某些配置。

@Configuration
@ConditionalOnClass(DataSource.class)
public class MySQLAutoConfiguration{}

@ConditionalOnBean与@ConditionalOnMissingBean

这两个注解属于对象条件注解，根据是否存在某个对象作为依据来决定是否要执行某些配置方法。

@Bean
@ConditionalOnBean(name="dataSource")
LocalContainerEntityManagerFactoryBean entityManagerFactory(){//...
}@Bean
@ConditionalOnMissingBean
public MyBean myBean(){//...
}

@ConditionalOnWebApplication与@ConditionalOnNotWebApplication

这两个注解用于判断当前的应用程序是否是Web应用程序。如果当前应用是Web应用程序，则使用Spring WebApplicationContext,并定义其会话的生命周期。

@ConditionalOnWebApplication
HealthCheckController healthCheckController(){//...
}

@ConditionalOnProperty

会根据Spring配置文件中的配置项是否满足配置要求，从而决定是否要执行被其标注的方法

@Bean
@ConditionalOpProperty(name="alipay",havingValue="od")
Alipay alipay(){return new Alipay();
}

@ConditionalOnResource

此注解用于检测当某个配置文件存在时，则触发被其标注的方法

@ConditionalOnResource(resources = "classpath:website.properties")
Properties addWebsiteProperties(){}

@ConditionalExpression

此注解可以让我们控制更细粒度的基于表达式的配置条件限制。当表达式满足某个条件或者表达式为真的时候，将会执行被此注解标注的方法。

@Bean
@ConditionalException("${localstore} && ${local == 'true'}")
LocalFileStore store(){//...
}

@Conditional

可以控制更为复杂的配置条件。在Spring内置的条件控制注解不满足应用需求的时候，可以使用此注解定义自定义的控制条件，以达到自定义的要求。

@Conditioanl(CustomConditioanl.class)
CustomProperties addCustomProperties(){//...
}

@Endpoint

SpringBoot Actoator中的监视和管理应用程序，通过/health端点报告应用程序的健康状态，在诊断问题或调整性能时，内存使用情况、垃圾收集、活动线程等。

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

注释一个类时@Endpoint会获得某些功能：

  • ID:为端点分配一个ID，使其可以通过自定义URL进行访问
  • 启用/禁用：可以通过属性有选择地启用或禁用端点
  • 安全性：用用安全规则来限制对端点的访问
  • 操作：定义端点将公开哪些操作（读、写、删除）
@Endpoint(id="helloWorld") //标志该类为一个执行器端点，通过 URL 进行访问/actuator/helloWorld
public class HelloWorldEndpoint{@ReadOperation //可以使用 HTTP GET 请求来调用该方法public String sayHello(){return "Hello,World!";}
}

安全影响：
通过应用程序的属性文件指定访问每个端点所需的角色，甚至完全禁用某些端点

# helloWorld端点已启用并仅限于具有“ADMIN”角色的用户
management.endpoint.helloWorld.enabled = true
management.endpoint.helloWorld.roles = ADMIN

以下三个注释：允许您在自定义端点上公开方法，分别用于读取、写入和删除数据或操作方面
本质上，它们映射到 HTTP GET、POST/PUT 和 DELETE 方法，尽管它们不限于 HTTP 并且可以通过 JMX 等其他协议公开

@ReadOperation

@Endpoint(id="diskSpace")
public class DiskSpaceEndpoint{@ReadOperationpublic long getFreeDiskSpace(){ //考虑一个公开系统上可用磁盘空间的自定义端点File file = new File("/");return file.getFreeSpace();}
}

@WriteOperation

相当于执行器端点的 HTTP POST 或 PUT。您可以使用它来更新配置、启用或禁用功能或启动特定操作

@Endpoint(id="featureToggle")
public class FeatureToggleEndpoint{private AtomicBoolean featureEnabled = new AtomicBoolean(true);@WriteOperationpublic String toggleFeature(){featureEnable.set(!featureEnabled.get());return "Feature is now " + (featureEnabled.get() ? "enabled" : "disabled");}
}

@DeleteOperation

公开了类似 HTTP DELETE 的操作。这通常用于清理资源或将应用程序的某些方面重置为其默认状态。

/**清除内存缓存的端点
*/
@Endpoint(id="cache")
public class CacheEndpoint{private Map<String,Object> cache = new ConcurrentHashMap<>();@DeleteOperationpublic String clearCache(){cache.clear();return "Cache cleared";}
}

在@ReadOperation方法中使用查询参数，或在@WriteOperation和@DeleteOperation方法中使用请求正文和路径变量，从而使您能够更好地控制和灵活地控制自定义端点的功能

创建自定义执行器端点

①、使用@Endpoint创建一个Spring组件

@Endpoint(id="activeUser")
public class ActiveUserspoint{//实现将在此处
}

②、添加操作方法

添加方法来公开不同的操作，@ReadOperation公开活跃用户的数量

public class ActiveUsersEndpoint{@ReadOperationpublic int getActiveUsers(){//通常，此数据可能来自数据库或其他外部源return 5;}
}

③、保护端点（可选）

自定义端点暴露了敏感数据或功能，那么保护它就至关重要。您可以使用文件中的属性application.properties或直接在代码中进行配置。

management.endpoint.activeUsers.enabled = true 
management.endpoint.activeUsers.roles = ADMIN

④、测试端点

新端点应该可以通过类似 的 URL 访问http://localhost:8080/actuator/activeUsers
您可能希望端点更具交互性。您可以根据您的要求添加更多带有@WriteOperation和注释的操作方法。@DeleteOperation

public class ActiveUserEndpoint{@WriteOperationpublic String addUser(){//将新用户添加到活动用户列表return "用户添加成功";}@DeleteOperationpublic String removeUser(){//从活跃用户列表中删除用户return "用户删除成功";}
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/92218.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

cesium 雷达扫描 （线行扩散效果）

cesium 雷达扫描 （线行扩散效果）

cesium 雷达扫描 （线行扩散效果） 1、实现方法 使用ellipse方法加载圆型，修改ellipse中material方法来实现效果 2、示例代码 2.1、 <!DOCTYPE html> <html lang="en"><head><<
阅读更多...
python代码混淆与代码打包

python代码混淆与代码打包

0x00 背景 自己写的项目&#xff0c;又想保护源码&#xff0c;自己做个混淆是最方便的了。 0x01 实践 这里使用开源工具 GitHub - astrand/pyobfuscate: pyobfuscate&#xff0c;虽然git上才500多star&#xff0c;但是很好用。它的使用场景是混淆单个py文件。很多事物有开始就…
阅读更多...
如何利用niceGUI构建一个流式单轮对话界面

如何利用niceGUI构建一个流式单轮对话界面

官方文档 参考文档 import asyncio import time import requests from fastapi import FastAPI from nicegui import app, uiclass ChatPage:temperature: ui.slider Nonetop_p: ui.slider Noneapi_key: ui.input Nonemodel_name: ui.input Noneprompt: ui.textarea None…
阅读更多...
文心一言 VS 讯飞星火 VS chatgpt （103）-- 算法导论10.1 1题

文心一言 VS 讯飞星火 VS chatgpt （103）-- 算法导论10.1 1题

一、用go语言&#xff0c;仿照图 10-1&#xff0c;画图表示依次执行操作 PUSH(S&#xff0c;4)、PUSH(S&#xff0c;1)、PUSH(S&#xff0c;3)、POP(S)、PUSH(S&#xff0c;8)和 POP(S)每一步的结果&#xff0c;栈 S初始为空&#xff0c;存储于数组 S[1…6]中。 文心一言&…
阅读更多...
第5章-宏观业务分析方法-5.3-主成分分析法

第5章-宏观业务分析方法-5.3-主成分分析法

5.3.1 主成分分析简介 主成分分析是以最少的信息丢失为前提，将原有变量通过线性组合的方式综合成少数几个新变量；用新变量代替原有变量参与数据建模，这样可以大大减少分析过程中的计算工作量；主成分对新变量的选取不是对原有变量的简单取舍，而是原有变量重组后的结果，因此…
阅读更多...
【网络协议】IP

【网络协议】IP

当连接多个异构的局域网形成强烈需求时&#xff0c;用户不满足于仅在一个局域网内进行通信&#xff0c;他们希望通过更高一层协议最终实现异构网络之间的连接。既然需要通过更高一层的协议将多个局域网进行互联&#xff0c;那么这个协议就必须为不同的局域网环境定义统一的寻址…
阅读更多...
jmh的OperationsPerInvocation参数

jmh的OperationsPerInvocation参数

背景 最近再看fllink的性能基准测试时&#xff0c;发现它使用了OperationsPerInvocation注解&#xff0c;本文就来记录下这个注解的含义 官方解释 从官方文档&#xff1a;http://javadox.com/org.openjdk.jmh/jmh-core/0.9/org/openjdk/jmh/annotations/OperationsPerInvoca…
阅读更多...
七、2023.10.1.Linux（一）.7

七、2023.10.1.Linux（一）.7

文章目录 1、 Linux中查看进程运行状态的指令、查看内存使用情况的指令、tar解压文件的参数。2、文件权限怎么修改&#xff1f;3、说说常用的Linux命令&#xff1f;4、说说如何以root权限运行某个程序&#xff1f;5、 说说软链接和硬链接的区别&#xff1f;6、说说静态库和动态…
阅读更多...
nginx隐藏版本号和标识

nginx隐藏版本号和标识

1.隐藏版本号:nginx-服务器banner泄漏风险_banner信息泄露_javachen__的博客-CSDN博客 2.隐藏nginx标识 cd /usr/local/nginx-1.24.0/src/corevi nginx.h在第14行 cd /usr/local/nginx-1.24.0/src/httpvi ngx_http_special_response.c在第22,29,36行 cd /usr/local/nginx-1.2…
阅读更多...
【知识梳理】多级页表的原理分析【地址形成过程】【扩充思考】

【知识梳理】多级页表的原理分析【地址形成过程】【扩充思考】

多级页表的地址形成过程 首先每个进程中都至少有一个页表&#xff08;段页式可以有多个页表&#xff09;&#xff0c;都有一个页表基地址寄存器&#xff08;PTBR&#xff09;&#xff0c;以下针对三级页表进行分析。 level1&#xff1a;PTBR代表的是一级页表的基地址&#xf…
阅读更多...
leetCode 376.摆动序列 贪心算法

leetCode 376.摆动序列 贪心算法

如果连续数字之间的差严格地在正数和负数之间交替&#xff0c;则数字序列称为 摆动序列 。第一个差&#xff08;如果存在的话&#xff09;可能是正数或负数。仅有一个元素或者含两个不等元素的序列也视作摆动序列。 例如&#xff0c; [1, 7, 4, 9, 2, 5] 是一个 摆动序列 &…
阅读更多...
labview 混合信号图 多曲线分组

labview 混合信号图 多曲线分组

如果你遇到了混合信号图 多曲线分组显示的问题&#xff0c;本文能给你帮助。 在文章的最好&#xff0c;列出了参考程序下载链接。 一个混合信号图中可包含多个绘图区域。 但一个绘图区域仅能显示数字曲线或者模拟曲线之一&#xff0c;无法兼有二者。 以下显示的分两组&#…
阅读更多...
ARM汇编基础指令整合

ARM汇编基础指令整合

汇编语言的组成 伪操作 不参与程序的执行&#xff0c;但是用于告诉编译器程序该怎么编译 如&#xff1a; .text .global .end .if .else .endif .data 汇编指令 汇编器将一条汇编指令编译成一条机器码&#xff0c;在内存里一条指令…
阅读更多...
公众号商城小程序的作用是什么

公众号商城小程序的作用是什么

公众号是微信平台重要的生态体系之一&#xff0c;它可以与其它体系连接实现多种效果&#xff0c;同时公众号内容创作者非常多&#xff0c;个人或企业商家等&#xff0c;会通过公众号分享信息或获得收益等&#xff0c;而当商家需要在微信做私域经营或想要转化粉丝、售卖产品时就…
阅读更多...
SELinux 介绍

SELinux 介绍

背景 在工作中经常需要在 android 中增加一些东西&#xff0c; 而android有自己的安全限制&#xff0c;如果不懂SELinux&#xff0c;就不好添加。 Control Access Model https://zh.wikipedia.org/wiki/Chmod https://linux.die.net/man/1/chcon DAC DAC and Trojan Horses D…
阅读更多...
一维数组和二维数组的使用（一）

一维数组和二维数组的使用（一）

目录 导读1. 一维数组1.1 一维数组的创建1.2 数组的初始化1.3 一维数组的使用1.4 一维数组在内存中的存储 2. 二维数组2.1 二维数组的创建2.2 二维数组的初始化2.3 二维数组的使用2.4 二维数组在内存中的存储 博主有话说 导读 本篇主要讲解一维数组和二维数组的创建和使用&…
阅读更多...
dart flutter json 转 model 常用库对比 json_serializable json_model JsonToDart

dart flutter json 转 model 常用库对比 json_serializable json_model JsonToDart

1.对比 我是一个初学者,一直跟着教材用原生的json,最近发现实在太麻烦了.所以搜索了一下,发现真的有很多现成的解决方案. 网页 https://app.quicktype.io/?ldart 这个是测试下来最好用的 有很多选项,可以使用 json_serializable 也可以不使用 json_serializable 这是推荐最…
阅读更多...
机器人入门（一）

机器人入门（一）

机器人入门&#xff08;一&#xff09; 一、ROS是什么&#xff0c;能用来干什么&#xff1f;二、哪些机器人用到了ROS&#xff1f;三、ROS和操作系统是绑定的吗&#xff1f;四、ROS 1 和ROS 2的关系是什么&#xff1f;4.1架构中间件改变API改变数据格式改变 4.2特性4.3工具/生态…
阅读更多...
前缀、中缀、后缀表达式相互转换工具

前缀、中缀、后缀表达式相互转换工具

目录 1. 界面一览 2. 使用说明 3. 实例演示 3.1 输入中缀 3.2 输入前缀 3.3 输入后缀 3.4 选择错误的类型 4. 代码 5. 资源地址 关于什么是前缀、中缀、后缀表达式&#xff0c;相信你不知道这个东西&#xff0c;那你也不会点进来这篇博客&#xff0c;当然&#xff0c;…
阅读更多...
计算机竞赛 深度学习机器视觉车道线识别与检测 -自动驾驶

计算机竞赛 深度学习机器视觉车道线识别与检测 -自动驾驶

文章目录 1 前言2 先上成果3 车道线4 问题抽象(建立模型)5 帧掩码(Frame Mask)6 车道检测的图像预处理7 图像阈值化8 霍夫线变换9 实现车道检测9.1 帧掩码创建9.2 图像预处理9.2.1 图像阈值化9.2.2 霍夫线变换 最后 1 前言 &#x1f525; 优质竞赛项目系列&#xff0c;今天要分…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023