SpringBoot常用的50个注解,一目了然

2023年 11月 10日 68.2k 0

我们在使用SpringBoot开发项目的时候,使用注解是最频繁和自然的事。这些注解让我们摆脱了繁琐的传统Spring XML配置,让我们开发项目更加高效和简单,springboot注解那么多,其实常用的也就不超过50个,现在我们就来聊聊SpringBoot中常用的注解。

常用注解概览

以下是SpringBoot常用注解的思维导图,本文主要讲解这些注解的用法。

@SpringBootApplication

作用:这是一个组合注解,包括了@Configuration、@EnableAutoConfiguration和@ComponentScan三个注解。用于标识SpringBoot应用程序的入口类。

@Configuration:指示这个类是一个配置类,它定义了一个或多个@Bean方法,用于创建和配置Spring应用程序上下文中的Bean。

@EnableAutoConfiguration:启用Spring Boot的自动配置机制,它会自动添加所需的依赖项和配置,以使应用程序能够运行。

@ComponentScan:指示Spring Boot扫描当前包及其子包中的所有@Component、@Service、@Repository和@Controller注解的类,并将它们注册为Spring Bean。

@SpringBootApplication注解通常被用于Spring Boot应用程序的入口类上,用于启动Spring Boot应用程序。它可以简化Spring应用程序的配置和启动过程。

用例:

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

@Aspect

作用:用于定义切面。

@Aspect是Spring框架中的一个注解,用于标识一个类为切面类,从而可以在该类中定义切面逻辑以实现AOP(面向切面编程)。

在Spring框架中,如果需要使用AOP来实现某些功能,我们可以使用@Aspect注解来标识一个类为切面类。在切面类中,我们可以定义切面逻辑,包括切入点、通知类型和切面顺序等,从而实现AOP编程的功能。

用例:

@Aspect
@Component
public class MyAspect {
      @Before("execution(* com.example.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注解标识这个类,以便Spring框架能够自动将它加入到Spring容器中。

在这个例子中,我们定义了一个MyAspect类来实现某些功能的切面编程。在这个类中,我们定义了两个通知类型,即@Before和@After,分别表示在目标方法执行前和执行后执行某些操作。这些通知类型的执行条件是通过切入点表达式来定义的。

@Aspect注解用于标识一个类为切面类,可以使得开发者更加方便地使用AOP来实现某些功能。它是一种简单但非常有效的解决方案,可以让开发者更加轻松地使用切面编程来提高应用程序的性能和可维护性。

@Aspect注解是Spring框架中比较常用的注解之一,用于标识一个类为切面类。需要注意的是,AOP的使用需要谨慎操作,必要时需要考虑切入点、通知类型和切面顺序等来维护应用程序的性能和可维护性。

@Pointcut

作用:用于定义切点。

@Pointcut是Spring框架中的一个注解,用于定义一个切入点,从而可以在该切入点上定义通知类型以实现AOP(面向切面编程)。

在Spring框架中,如果需要使用AOP来实现某些功能,我们可以使用@Pointcut注解来定义一个切入点。在切入点上,我们可以定义切面逻辑,包括通知类型和切面顺序等,从而实现AOP编程的功能。

用例:

@Aspect
@Component
public class MyAspect {
      @Pointcut("execution(* com.example.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.");
      }
}

这个类使用@Aspect注解标识,表示这个类是一个切面类。同时,我们还使用@Component注解标识这个类,以便Spring框架能够自动将它加入到Spring容器中。

在这个例子中,我们定义了一个MyAspect类来实现某些功能的切面编程。在这个类中,我们使用@Pointcut注解定义了一个切入点,即userServicePointcut()方法。在这个切入点上,我们定义了两个通知类型,即@Before和@After,分别表示在目标方法执行前和执行后执行某些操作。

@Pointcut注解用于定义一个切入点,可以使得开发者更加方便地使用AOP来实现某些功能。它是一种简单但非常有效的解决方案,可以让开发者更加轻松地使用切面编程来提高应用程序的性能和可维护性。

@Pointcut注解是Spring框架中比较常用的注解之一,用于定义一个切入点。需要注意的是,AOP的使用需要谨慎操作,必要时需要考虑切入点、通知类型和切面顺序等来维护应用程序的性能和可维护性。

@Before

作用:用于在方法执行前执行通知。

@Before是Spring框架中的一个注解,用于定义在目标方法执行前执行的通知类型,以实现AOP(面向切面编程)。

在Spring框架中,如果需要在目标方法执行前执行某些操作,我们可以使用@Before注解来定义一个通知类型。在这个通知类型中,我们可以编写自己的逻辑代码,从而实现AOP编程的功能。

用例:

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

@After

作用:用于在方法执行后执行通知。

@After是Spring框架中的一个注解,用于定义在目标方法执行后执行的通知类型,以实现AOP(面向切面编程)。

在Spring框架中,如果需要在目标方法执行后执行某些操作,我们可以使用@After注解来定义一个通知类型。在这个通知类型中,我们可以编写自己的逻辑代码,从而实现AOP编程的功能。

用例:

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

@Around

作用:用于在方法执行前后执行通知。

@Around是Spring框架中的一个注解,用于定义在目标方法执行前后执行的通知类型,以实现AOP(面向切面编程)。

在Spring框架中,如果需要在目标方法执行前后执行某些操作,我们可以使用@Around注解来定义一个通知类型。在这个通知类型中,我们可以编写自己的逻辑代码,从而实现AOP编程的功能。

用例:

@Aspect
@Component
public class MyAspect {
        @Around("execution(* com.example.UserService.*(..))")
        public Object aroundAdvice(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("Before advice is executed.");
        Object result = joinPoint.proceed();
        System.out.println("After advice is executed.");
        return result;
        }
}

@AfterReturning

作用:用于在方法返回结果后执行通知。

@AfterReturning是Spring框架中的一个注解,用于定义在目标方法返回结果后执行的通知类型,以实现AOP(面向切面编程)。

在Spring框架中,如果需要在目标方法返回结果后执行某些操作,我们可以使用@AfterReturning注解来定义一个通知类型。在这个通知类型中,我们可以编写自己的逻辑代码,从而实现AOP编程的功能。

用例:

@Aspect
@Component
public class MyAspect {
      @AfterReturning(pointcut = "execution(* com.example.UserService.*(..))", returning = "result")
      public void afterReturningAdvice(Object result) {
      System.out.println("After returning advice is executed. Result is " + result);
      }
}

@AfterThrowing

作用:用于在方法抛出异常后执行通知。

@AfterThrowing是Spring框架中的一个注解,用于定义在目标方法抛出异常后执行的通知类型,以实现AOP(面向切面编程)。

在Spring框架中,如果需要在目标方法抛出异常后执行某些操作,我们可以使用@AfterThrowing注解来定义一个通知类型。在这个通知类型中,我们可以编写自己的逻辑代码,从而实现AOP编程的功能。

用例:

@Aspect
@Component
public class MyAspect {
        @AfterThrowing(pointcut = "execution(* com.example.UserService.*(..))", throwing = "ex")
        public void afterThrowingAdvice(Exception ex) {
        System.out.println("After throwing advice is executed. Exception is " + ex);
        }
}

@Order

作用:用于指定切面的执行顺序。

@Order是Spring框架中的一个注解,用于定义切面的执行顺序。

在Spring框架中,如果有多个切面类需要对同一个方法进行切面处理,那么这些切面类的执行顺序可能会影响到最终的结果。为了控制这些切面类的执行顺序,我们可以使用@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.");
        }
}

@RestController

作用:与@Controller类似,但是@RestController会自动将返回值转换为JSON格式。

@RestController是Spring Framework 4.0版本引入的一个注解,它是@Controller和@ResponseBody的组合注解。它用于标注一个类,表示这个类是一个RESTful风格的控制器,可以处理HTTP请求并返回JSON/XML格式的响应。

@RestController注解用于替代原来的@Controller注解,它默认情况下会将控制器方法的返回值转换为JSON格式,并以HTTP响应的方式返回给客户端。如果需要返回XML格式的响应,可以使用其他注解,如@Produces和@Consumes。

用例:

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
    			return "Hello, World!";
    }
}

@RequestMapping

作用:用于映射请求URL和处理方法。@RequestMapping是Spring MVC框架中的一个核心注解,它用于映射HTTP请求和控制器方法之间的关系。它可以用于类级别和方法级别,用于指定请求URL和HTTP方法(GET、POST、PUT、DELETE等)。

用例:

@RestController
@RequestMapping("/api")
public class UserController {
        @GetMapping("/users")
        public List getUsers() {
        // 获取用户列表
        }
        @PostMapping("/users")
        public void createUser(@RequestBody User user) {
        // 创建新用户
        }
        @GetMapping("/users/{id}")
        public User getUserById(@PathVariable Long id) {
        // 根据ID获取用户信息
        }
        @PutMapping("/users/{id}")
        public void updateUser(@PathVariable Long id, @RequestBody User user) {
        // 更新用户信息
        }
        @DeleteMapping("/users/{id}")
        public void deleteUser(@PathVariable Long id) {
        // 根据ID删除用户
        }
}

@GetMapping

作用:用于映射HTTP GET请求。

用例:

@RestController
@RequestMapping("/api")
public class UserController {
        @GetMapping("/users")
        public List getUsers() {
        // 获取用户列表
        }
        @GetMapping("/users/{id}")
        public User getUserById(@PathVariable Long id) {
        // 根据ID获取用户信息
        }
}

@PostMapping

作用:用于映射HTTP POST请求。

用例:

@RestController
@RequestMapping("/api")
public class UserController {
    @PostMapping("/users")
    public void createUser(@RequestBody User user) {
        // 创建新用户
    }
}

@PutMapping

作用:用于映射HTTP PUT请求。

用例:

@RestController
@RequestMapping("/api")
public class UserController {
      @PutMapping("/users/{id}")
      public void updateUser(@PathVariable Long id, @RequestBody User user) {
      // 更新用户信息
      }
}

@DeleteMapping

作用:用于映射HTTP DELETE请求。

用例:

@RestController
@RequestMapping("/api")
public class UserController {
      @DeleteMapping("/users/{id}")
      public void deleteUser(@PathVariable Long id) {
      // 根据ID删除用户
      }
}

@RequestParam

作用:用于获取请求参数的值。

用例:

@RestController
@RequestMapping("/api")
public class UserController {
      @GetMapping("/users")
      public List getUsers(@RequestParam("page") int page, @RequestParam("size") int size) {
      // 分页获取用户列表
      }
}

@PathVariable

作用:用于获取URL中的参数值。@PathVariable是Spring MVC框架中的一个注解,用于将HTTP请求路径中的变量绑定到控制器方法的参数上。

用例:

@RestController
@RequestMapping("/api")
public class UserController {
      @GetMapping("/users/{id}")
      public User getUser(@PathVariable Long id) {
      // 根据ID获取用户信息
      }
}

@RequestBody

作用:用于将HTTP请求的主体转换为方法的参数。@RequestBody是Spring MVC框架中的一个注解,用于将HTTP请求体中的数据绑定到控制器方法的参数上。

用例:

@RestController
@RequestMapping("/api")
public class UserController {
      @PostMapping("/users")
      public User createUser(@RequestBody User user) {
      // 创建用户
      }
}

@ResponseBody

作用:用于将方法的返回值转换为HTTP响应的主体。@ResponseBody是Spring MVC框架中的一个注解,用于将控制器方法的返回值转换为HTTP响应体中的数据。

用例:

@RestController
public class UserController {
      @GetMapping("/users/{id}")
      @ResponseBody
      public User getUser(@PathVariable int id) {
      // 从数据库或其他地方获取用户数据
      User user = userService.getUserById(id);
      return user;
      }
}

@Autowired

作用:用于自动装配Spring容器中的Bean。

用例:

@Service
public class UserServiceImpl implements UserService {
      @Autowired
      private UserRepository userRepository;
      // 实现UserService接口中的方法
}

@Component

作用:用于标识一个类是Spring容器中的组件。@Component是Spring框架中的一个通用注解,用于标注一个类作为Spring Bean。

用例:

@Component
public class UserServiceImpl implements UserService {
// 实现UserService接口中的方法
}

@Service

作用:用于标识一个类是Spring容器中的服务组件。@Service是Spring框架中的一个注解,用于标注一个类作为服务类(Service)。

用例:

@Service
public class UserServiceImpl implements UserService {
// 实现UserService接口中的方法
}

@Repository

作用:用于标识一个类是Spring容器中的数据访问组件。@Repository是Spring框架中的一个注解,用于标注一个类作为数据访问对象(DAO)。

用例:

@Repository
public class UserRepositoryImpl implements UserRepository {
// 实现UserRepository接口中的方法
}

@Configuration

作用:用于标识一个类是Spring的配置类。@Configuration是Spring框架中的一个注解,用于标注一个类作为配置类。

用例:

@Configuration
public class AppConfig {
        @Bean
        public UserService userService() {
        return new UserServiceImpl();
        }
        @Bean
        public UserRepository userRepository() {
        return new UserRepositoryImpl();
        }
}

@Value

作用:用于获取配置文件中的属性值。@Value是Spring框架中的一个注解,用于将配置文件中的属性值注入到Bean对象中。

用例:

@Component
public class MyComponent {
      @Value("${my.property}")
      private String myProperty;
      // 其他方法
}

这个类使用@Component注解标注,表示这个类是一个Spring Bean,可以被其他的Spring Bean自动装配。

在属性级别上,@Value注解指定了需要注入的属性值,这个属性值可以通过${...}的方式引用配置文件中的属性值。

在这个例子中,MyComponent类中的myProperty属性使用@Value注解指定了需要注入的属性值,Spring会自动将配置文件中名为my.property的属性值注入到这个属性中。

@Value注解用于注入配置文件中的属性值,使得开发者可以方便地从配置文件中获取属性值,并将其注入到Bean对象中。同时,使用@Value注解还可以方便地处理不同环境下的配置文件,如开发环境和生产环境的配置文件。

@Value注解是Spring框架中比较常用的注解之一,可以让开发者更加专注于业务逻辑的实现,而不必关心属性值的获取和注入细节。

@Bean

作用:用于将一个方法返回的对象注册到Spring容器中。@Bean是Spring框架中的一个注解,用于将一个方法返回的对象注册为一个Spring Bean。

用例:

@Configuration
public class AppConfig {
      @Bean
      public UserService userService() {
      return new UserServiceImpl();
      }
      @Bean
      public UserRepository userRepository() {
      return new UserRepositoryImpl();
      }
}

@Import

作用:用于导入其他配置类或Bean。

用例:

@Configuration
@Import({AppConfig1.class, AppConfig2.class})
public class AppConfig {
// 其他方法
}

@Conditional

作用:用于根据条件判断是否创建Bean或执行配置。

用例:

@Configuration
public class AppConfig {
      @Bean
      @Conditional(DatabaseTypeCondition.class)
      public UserRepository userRepository() {
      return new UserRepositoryImpl();
      }
// 其他方法
}

@Profile

作用:用于指定配置的环境,如开发环境、测试环境或生产环境。

用例:

@Configuration
public class AppConfig {
      @Bean
      @Profile("dev")
      public UserService userServiceDev() {
      return new UserServiceDevImpl();
      }
      @Bean
      @Profile("prod")
      public UserService userServiceProd() {
      return new UserServiceProdImpl();
      }
// 其他方法
}

@PropertySource

作用:用于指定配置文件的位置。@PropertySource是Spring框架中的一个注解,用于指定一组属性文件的位置,从而可以在Spring应用程序中使用这些属性。

用例:

@Configuration
@PropertySource("classpath:application.properties")
public class AppConfig {
      @Autowired
      private Environment environment;
      @Bean
      public UserService userService() {
      return new UserServiceImpl(environment.getProperty("userService.name"));
      }
      // 其他方法
}

这个类使用@Configuration注解标注,表示这个类是一个配置类,用于配置应用程序的Bean对象。

在类级别上,使用@PropertySource注解可以指定一个属性文件的位置。在这个例子中,使用@PropertySource注解指定了一个名为application.properties的属性文件,它位于classpath下。

在方法级别上,使用@Bean注解标注方法,表示这个方法返回一个Bean对象。在这个例子中,使用Environment对象从属性文件中读取属性值,并将这些属性值传递给UserService实例的构造方法。

@PropertySource注解用于指定一组属性文件的位置,使得开发者可以在Spring应用程序中使用这些属性。同时,使用Environment对象可以方便地读取属性文件中的属性值,并将这些属性值传递给Bean对象的构造方法或属性。

@PropertySource注解是Spring框架中比较常用的注解之一,可以让开发者更加灵活地管理和配置Spring Bean。

@Qualifier

作用:用于指定注入的Bean的名称。

用例:

@Component
public class UserServiceImpl implements UserService {
      @Autowired
      @Qualifier("userRepositoryImpl")
      private UserRepository userRepository;
      // 其他方法
}

@ExceptionHandler

作用:用于处理异常。

用例:

@ControllerAdvice
public class GlobalExceptionHandler {
        @ExceptionHandler(Exception.class)
        public ModelAndView handleException(Exception ex) {
              ModelAndView modelAndView = new ModelAndView();
              modelAndView.addObject("errorMessage", ex.getMessage());
              modelAndView.setViewName("error");
              return modelAndView;
        }
}

这个类使用@ControllerAdvice注解标注,表示这个类是一个全局异常处理器。在方法级别上,使用@ExceptionHandler注解可以指定一个方法来处理控制器中抛出的异常。

在这个例子中,使用@ExceptionHandler注解指定了一个名为handleException的方法,它处理所有类型的异常。当控制器中抛出异常时,会调用这个方法,并将异常对象作为参数传递给这个方法。

在这个方法中,使用ModelAndView对象来封装错误信息,并将视图名称设置为error。最后,返回这个ModelAndView对象,将错误信息显示到用户界面上。

@ExceptionHandler注解用于处理控制器中抛出的异常,使得开发者可以根据需要灵活地处理异常。同时,使用@ControllerAdvice注解可以将这个异常处理器应用于所有的控制器中。

@ExceptionHandler注解是Spring框架中比较常用的注解之一,可以让开发者更加灵活地处理控制器中的异常。

@ResponseStatus

作用:用于指定异常的HTTP响应状态码。

用例:

@Controller
public class UserController {
        @GetMapping("/user/{id}")
        @ResponseBody
        @ResponseStatus(HttpStatus.OK)
        public UserDetails getUserDetails(@PathVariable("id") Long id) {
              // 查询用户信息
              UserDetails userDetails = userService.getUserDetails(id);
              if (userDetails == null) {
              throw new UserNotFoundException("User not found");
              }
              return userDetails;
        }
  
        @ExceptionHandler(UserNotFoundException.class)
        @ResponseStatus(HttpStatus.NOT_FOUND)
        @ResponseBody
        public String handleUserNotFoundException(UserNotFoundException ex) {
        			return ex.getMessage();
        }
}

@ControllerAdvice

作用:用于全局处理异常。

@ControllerAdvice是Spring框架中的一个注解,用于定义全局控制器通知。

在Spring MVC框架中,控制器通知是一些特殊的组件,它们可以在控制器方法执行前、执行后或抛出异常时执行一些额外的逻辑处理。使用@ControllerAdvice注解可以定义全局控制器通知,它可以应用于所有的控制器。

用例:

@ControllerAdvice
public class GlobalControllerAdvice {
          @ModelAttribute("currentUser")
          public User getCurrentUser() {
                // 获取当前登录用户信息
                User currentUser = userService.getCurrentUser();
                return currentUser;
          }
          @InitBinder
          public void initBinder(WebDataBinder binder) {
         			 // 注册自定义的属性编辑器
          			binder.registerCustomEditor(Date.class, new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd"), true));
          }
          @ExceptionHandler(Exception.class)
          public ModelAndView handleException(Exception ex) {
                ModelAndView modelAndView = new ModelAndView();
                modelAndView.addObject("errorMessage", ex.getMessage());
                modelAndView.setViewName("error");
                return modelAndView;
          }
}

这个类使用@ControllerAdvice注解标注,表示这个类是一个全局控制器通知。在方法级别上,使用@ModelAttribute注解标注方法,表示这个方法会在所有控制器方法执行前执行,用于将当前登录用户信息添加到模型中。

使用@InitBinder注解标注方法,表示这个方法会在所有控制器方法执行前执行,用于注册自定义的属性编辑器。

使用@ExceptionHandler注解标注方法,表示这个方法会在控制器中抛出异常时执行,用于处理控制器方法中抛出的异常。

@ControllerAdvice注解用于定义全局控制器通知,使得开发者可以在所有控制器方法执行前、执行后或抛出异常时执行一些额外的逻辑处理。同时,使用@ModelAttribute注解可以将一些公共的模型数据添加到模型中,使用@InitBinder注解可以注册自定义的属性编辑器,使用@ExceptionHandler注解可以处理控制器方法中抛出的异常。

@ControllerAdvice注解是Spring框架中比较常用的注解之一,可以让开发者更加灵活地定义全局控制器通知。

@CrossOrigin

作用:用于解决跨域问题。

@CrossOrigin是Spring框架中的一个注解,用于解决跨域资源共享(CORS)问题。

跨域资源共享是浏览器安全策略的一部分,它限制了浏览器在不同域名之间发送和接收HTTP请求。使用@CrossOrigin注解可以指定允许跨域访问的域名和HTTP方法。

用例:

@RestController
@RequestMapping("/api")
@CrossOrigin(origins = "http://localhost:8080", methods = {RequestMethod.GET, RequestMethod.POST})
public class ApiController {
      @GetMapping("/users")
      public List getUsers() {
            // 查询用户信息
            List users = userService.getUsers();
            return users;
      }
}

这个类使用@RestController注解标注,表示这个类是一个RESTful风格的控制器。在类级别上,使用@RequestMapping注解指定控制器处理的请求路径为/api。同时,使用@CrossOrigin注解可以指定允许跨域访问的域名和HTTP方法。

在这个例子中,使用@CrossOrigin注解指定允许来自http://localhost:8080域名的GET和POST请求访问该控制器中的方法。这意味着,在http://localhost:8080域名下的网页可以通过XMLHttpRequest对象发送GET和POST请求,访问该控制器中的方法。

@CrossOrigin注解用于解决跨域资源共享(CORS)问题,使得开发者可以更加灵活地控制允许跨域访问的域名和HTTP方法。它是一种简单但非常有效的解决方案,可以使得前端开发者更加轻松地开发跨域应用程序。

@CrossOrigin注解是Spring框架中比较常用的注解之一,可以让开发者更加灵活地解决跨域资源共享(CORS)问题。

@Async

作用:用于将方法标记为异步执行。

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

用例:

@Service
public class UserService {
      @Async
      public CompletableFuture getUserDetailsAsync(Long id) {
            // 查询用户信息
            UserDetails userDetails = userRepository.getUserDetails(id);
            return CompletableFuture.completedFuture(userDetails);
      }
}

这个类使用@Service注解标注,表示这个类是一个服务。在方法级别上,使用@Async注解标注方法,表示这个方法需要异步执行。

在这个例子中,getUserDetailsAsync方法使用@Async注解标注,表示这个方法需要异步执行。查询用户信息的操作在异步线程中执行,不会阻塞主线程。同时,这个方法返回一个CompletableFuture对象,表示异步执行的结果。

@Async注解用于异步执行方法,可以提高应用程序的响应性能。它是一种简单但非常有效的解决方案,可以使得开发者更加轻松地编写并发应用程序。

@Async注解是Spring框架中比较常用的注解之一,可以让开发者更加灵活地异步执行方法。需要注意的是,异步执行的方法必须在一个独立的线程中执行,因此需要使用线程池来管理异步线程的执行。

@Cacheable

作用:用于缓存方法的返回值。

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

用例:

@Service
public class UserService {
      @Cacheable("userCache")
      public User getUser(Long id) {
            // 查询用户信息
            User user = userRepository.getUser(id);
            return user;
      }
}

这个类使用@Service注解标注,表示这个类是一个服务。在方法级别上,使用@Cacheable注解标注方法,表示这个方法返回的结果可以被缓存起来。

在这个例子中,getUser方法使用@Cacheable注解标注,表示这个方法的返回结果可以被缓存起来。查询用户信息的操作在第一次执行时会被执行,返回结果会被缓存到名为"userCache"的缓存中。下次执行getUser方法时,如果缓存中已经存在这个结果,就直接从缓存中获取结果,不需要再次执行查询操作。

@Cacheable注解用于缓存方法的返回结果,可以提高应用程序的执行效率。它是一种简单但非常有效的解决方案,可以使得开发者更加灵活地使用缓存来优化应用程序的性能。

@Cacheable注解是Spring框架中比较常用的注解之一,可以让开发者更加轻松地使用缓存来提高应用程序的性能。需要注意的是,使用缓存需要考虑缓存的生命周期和缓存的一致性,必要时需要使用缓存失效机制和缓存更新机制来维护缓存的一致性。

@CacheEvict

作用:用于清除缓存。

@CacheEvict是Spring框架中的一个注解,用于清空缓存中的数据。

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

用例:

@Service
public class UserService {
      @Cacheable("userCache")
      public User getUser(Long id) {
              // 查询用户信息
              User user = userRepository.getUser(id);
              return user;
      }

      @CacheEvict("userCache")
            public void clearCache() {
            // 清空缓存
      }
}

这个类使用@Service注解标注,表示这个类是一个服务。在方法级别上,使用@Cacheable注解标注getUser方法,表示这个方法的返回结果可以被缓存起来。同时,使用@CacheEvict注解标注clearCache方法,表示这个方法会清空名为"userCache"的缓存。

在这个例子中,getUser方法使用@Cacheable注解标注,表示这个方法的返回结果可以被缓存起来。查询用户信息的操作在第一次执行时会被执行,返回结果会被缓存到名为"userCache"的缓存中。下次执行getUser方法时,如果缓存中已经存在这个结果,就直接从缓存中获取结果,不需要再次执行查询操作。

当调用clearCache方法时,@CacheEvict注解会清空名为"userCache"的缓存,下次执行getUser方法时,就需要重新查询数据并缓存起来。

@CacheEvict注解用于清空缓存中的数据,可以使得开发者更加灵活地控制缓存的生命周期和缓存的一致性。它是一种简单但非常有效的解决方案,可以使得开发者更加轻松地使用缓存来提高应用程序的性能。

@CacheEvict注解是Spring框架中比较常用的注解之一,可以让开发者更加灵活地控制缓存的生命周期和缓存的一致性。需要注意的是,清空缓存需要谨慎操作,必要时需要考虑缓存的失效机制和缓存更新机制来维护缓存的一致性。

@CachePut

作用:用于更新缓存中的数据。

@CachePut是Spring框架中的一个注解,用于更新或添加缓存中的数据。

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

用例:

@Service
public class UserService {
        @Cacheable("userCache")
        public User getUser(Long id) {
                // 查询用户信息
                User user = userRepository.getUser(id);
                return user;
        }

        @CachePut("userCache")
        public User updateUser(Long id, User user) {
            // 更新用户信息
            User updatedUser = userRepository.updateUser(id, user);
            return updatedUser;
        }
}

这个类使用@Service注解标注,表示这个类是一个服务。在方法级别上,使用@Cacheable注解标注getUser方法,表示这个方法的返回结果可以被缓存起来。同时,使用@CachePut注解标注updateUser方法,表示这个方法会更新或添加名为"userCache"的缓存。

在这个例子中,getUser方法使用@Cacheable注解标注,表示这个方法的返回结果可以被缓存起来。查询用户信息的操作在第一次执行时会被执行,返回结果会被缓存到名为"userCache"的缓存中。下次执行getUser方法时,如果缓存中已经存在这个结果,就直接从缓存中获取结果,不需要再次执行查询操作。

当调用updateUser方法时,@CachePut注解会更新或添加名为"userCache"的缓存,下次执行getUser方法时,就可以从缓存中获取更新后的用户信息。

@CachePut注解用于更新或添加缓存中的数据,可以使得开发者更加灵活地控制缓存的生命周期和缓存的一致性。它是一种简单但非常有效的解决方案,可以使得开发者更加轻松地使用缓存来提高应用程序的性能。

@CachePut注解是Spring框架中比较常用的注解之一,可以让开发者更加灵活地控制缓存的生命周期和缓存的一致性。需要注意的是,更新或添加缓存需要谨慎操作,必要时需要考虑缓存的失效机制和缓存更新机制来维护缓存的一致性。

@Transactional

作用:用于指定事务的范围。

用例:

@Transactional(rollbackFor = Exception.class)
public void saveUserData() {
    //save data to db
}

@EnableTransactionManagement

作用:用于启用事务管理功能。

@Transactional是Spring框架中的一个注解,用于标识一个方法或类需要使用事务进行操作。

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

用例:

@Service
@Transactional
public class UserService {
        @Autowired
        private 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);
              }
        }
}

这个类使用@Service注解标注,表示这个类是一个服务。同时,在类级别上使用@Transactional注解标注,表示这个类中的所有方法都需要使用事务进行操作。

在这个例子中,createUser和updateUser方法都需要对数据库进行操作,因此使用userRepository来保存或更新用户信息。由于这个类使用了@Transactional注解来标识,因此userRepository的操作都在一个事务中进行,从而保证操作的原子性、一致性、隔离性和持久性。

@Transactional注解用于标识一个方法或类需要使用事务进行操作,可以使得开发者更加灵活地控制事务的使用。它是一种简单但非常有效的解决方案,可以使得开发者更加轻松地使用事务来提高应用程序的性能和数据一致性。

@Transactional注解是Spring框架中比较常用的注解之一,可以让开发者更加灵活地控制事务的使用。需要注意的是,事务的使用需要谨慎操作,必要时需要考虑事务的隔离级别、超时时间和回滚机制等来维护数据的一致性和应用程序的性能。

@EnableAspectJAutoProxy

作用:用于启用AOP功能。

@EnableAspectJAutoProxy是Spring框架中的一个注解,用于启用自动代理功能,以便使用AOP(面向切面编程)进行编程。

在Spring框架中,如果需要使用AOP来实现某些功能,我们可以使用@EnableAspectJAutoProxy注解来启用自动代理功能,从而在运行时自动为我们生成代理对象,以便进行切面编程。

用例:

@Configuration
@EnableAspectJAutoProxy
public class AppConfig {
      @Bean
      public MyAspect myAspect() {
      			return new MyAspect();
      }

      @Bean
      public UserService userService() {
     			 return new UserService();
      }
}

这个类使用@Configuration注解标注,表示这个类是一个配置类。同时,在类级别上使用@EnableAspectJAutoProxy注解标注,表示这个配置类需要启用自动代理功能。

在这个例子中,我们定义了一个MyAspect类来实现某些功能的切面编程。为了让Spring框架能够自动为我们生成代理对象,我们需要将MyAspect类加入到Spring容器中,并且使用@Bean注解标注。另外,我们还定义了一个UserService类来实现某些业务功能。

@EnableAspectJAutoProxy注解用于启用自动代理功能,可以使得开发者更加方便地使用AOP来实现某些功能。它是一种简单但非常有效的解决方案,可以让开发者更加轻松地使用切面编程来提高应用程序的性能和可维护性。

@EnableAspectJAutoProxy注解是Spring框架中比较常用的注解之一,可以让开发者更加方便地使用AOP来实现某些功能。需要注意的是,AOP的使用需要谨慎操作,必要时需要考虑AOP的切面逻辑、切入点和通知类型等来维护应用程序的性能和可维护性。

@Data

作用:用于自动生成JavaBean的getters、setters、toString、hashCode和equals方法。

@Data是Lombok框架中的一个注解,可以自动生成Java类的getter、setter、equals、hashCode和toString等方法。

在Java开发中,我们经常需要编写一些POJO类来表示数据结构。这些类通常包含一些成员变量,并且需要编写相应的getter、setter、equals、hashCode和toString等方法。这些方法通常是相似的,而且比较繁琐。为了简化这个过程,Lombok框架提供了一个@Data注解,可以自动生成这些方法。

使用@Data注解非常简单,只需要在Java类上添加这个注解即可。在使用时,我们可以直接访问类的成员变量,并且可以自动生成相应的getter、setter、equals、hashCode和toString等方法。

用例:

@Data
public class User {
      private Long id;
      private String name;
      private Integer age;
}

@NoArgsConstructor

作用:用于生成无参构造函数。

@NoArgsConstructor是Lombok框架中的一个注解,用于自动生成一个无参构造方法。

在Java开发中,我们经常需要编写一些POJO类来表示数据结构。这些类通常包含一些成员变量,并且需要编写相应的构造方法。在某些情况下,我们可能需要编写一个无参构造方法,用于创建一个对象的实例。这个构造方法通常是简单的、无需参数的。为了简化这个过程,Lombok框架提供了一个@NoArgsConstructor注解,可以自动生成一个无参构造方法。

使用@NoArgsConstructor注解非常简单,只需要在Java类上添加这个注解即可。在使用时,我们可以直接创建对象的实例,而不需要手动编写无参构造方法。

用例:

@NoArgsConstructor
public class User {
      private Long id;
      private String name;
      private Integer age;
}

在这个例子中,我们定义了一个User类,并使用@NoArgsConstructor注解来自动生成一个无参构造方法。然后,在其他的Java类中,我们可以直接创建User对象的实例,而不需要手动编写无参构造方法。

需要注意的是,使用@NoArgsConstructor注解需要在编译器中安装Lombok插件,否则可能会出现编译错误。另外,虽然@NoArgsConstructor注解非常方便,但在实际应用中,我们还需要根据实际情况选择合适的构造方法,并编写相应的代码。

总之,@NoArgsConstructor是Lombok框架中的一个注解,用于自动生成一个无参构造方法,从而简化Java开发的过程。它是一种极为方便的解决方案,可以提高应用程序的可维护性和可读性。

@AllArgsConstructor

作用:用于生成全参构造函数。

@AllArgsConstructor是Lombok框架中的一个注解,用于自动生成一个全参构造方法。

在Java开发中,我们经常需要编写一些POJO类来表示数据结构。这些类通常包含一些成员变量,并且需要编写相应的构造方法。在某些情况下,我们可能需要编写一个全参构造方法,用于初始化所有成员变量。这个构造方法通常包含所有成员变量作为参数。为了简化这个过程,Lombok框架提供了一个@AllArgsConstructor注解,可以自动生成一个全参构造方法。

使用@AllArgsConstructor注解非常简单,只需要在Java类上添加这个注解即可。在使用时,我们可以直接创建对象的实例,并传入相应的参数,而不需要手动编写全参构造方法。

用例:

@AllArgsConstructor
public class User {
      private Long id;
      private String name;
      private Integer age;
}

在这个例子中,我们定义了一个User类,并使用@AllArgsConstructor注解来自动生成一个全参构造方法。然后,在其他的Java类中,我们可以直接创建User对象的实例,并传入相应的参数,而不需要手动编写全参构造方法。

需要注意的是,使用@AllArgsConstructor注解需要在编译器中安装Lombok插件,否则可能会出现编译错误。另外,虽然@AllArgsConstructor注解非常方便,但在实际应用中,我们还需要根据实际情况选择合适的构造方法,并编写相应的代码。

总之,@AllArgsConstructor是Lombok框架中的一个注解,用于自动生成一个全参构造方法,从而简化Java开发的过程。它是一种极为方便的解决方案,可以提高应用程序的可维护性和可读性。

@Builder

作用:用于生成Builder模式的构造函数。

@Builder是Lombok框架中的一个注解,用于自动生成一个Builder模式的构造器。

在Java开发中,我们经常需要编写一些POJO类来表示数据结构。这些类通常包含一些成员变量,并且需要编写相应的构造方法。在某些情况下,我们可能需要编写一个Builder模式的构造器,用于方便地创建对象实例。Builder模式是一种创建对象的设计模式,它可以通过链式调用的方式设置对象的属性,并最终创建一个不可变的对象。为了简化这个过程,Lombok框架提供了一个@Builder注解,可以自动生成一个Builder模式的构造器。

使用@Builder注解非常简单,只需要在Java类上添加这个注解即可。在使用时,我们可以使用链式调用的方式设置对象的属性,并最终创建一个不可变的对象。

用例:

@Builder
public class User {
      private Long id;
      private String name;
      private Integer age;
}

在这个例子中,我们定义了一个User类,并使用@Builder注解来自动生成一个Builder模式的构造器。然后,在其他的Java类中,我们可以使用链式调用的方式设置User对象的属性,并最终创建一个不可变的对象。

需要注意的是,使用@Builder注解需要在编译器中安装Lombok插件,否则可能会出现编译错误。另外,虽然@Builder注解非常方便,但在实际应用中,我们还需要根据实际情况选择合适的构造方法,并编写相应的代码。

总之,@Builder是Lombok框架中的一个注解,用于自动生成一个Builder模式的构造器,从而简化Java开发的过程。它是一种极为方便的解决方案,可以提高应用程序的可维护性和可读性。

@EqualsAndHashCode

作用:用于生成hashCode和equals方法。

@EqualsAndHashCode是Lombok框架中的一个注解,用于自动生成equals()和hashCode()方法。

在Java开发中,我们经常需要比较两个对象是否相等,并且需要根据对象的属性生成一个hashCode值。为了简化这个过程,Lombok框架提供了一个@EqualsAndHashCode注解,可以自动生成equals()和hashCode()方法。

使用@EqualsAndHashCode注解非常简单,只需要在Java类上添加这个注解即可。在使用时,Lombok会根据类的属性自动生成equals()和hashCode()方法。如果两个对象的所有属性都相等,那么它们的equals()方法返回true,并且它们的hashCode()方法返回相同的值。

用例:

@EqualsAndHashCode
public class User {
      private Long id;
      private String name;
      private Integer age;
}

@ToString

作用:用于生成toString方法。

@ToString是Lombok框架中的一个注解,用于自动生成toString()方法。

在Java开发中,我们经常需要将对象转换为字符串,以便于输出或日志记录。为了简化这个过程,Lombok框架提供了一个@ToString注解,可以自动生成toString()方法。

使用@ToString注解非常简单,只需要在Java类上添加这个注解即可。在使用时,Lombok会根据类的属性自动生成toString()方法,这个方法将输出类的名称和所有属性的名称和值。如果需要排除某些属性,可以使用exclude属性来指定排除的属性。

用例:

@ToString(exclude = "password")
public class User {
    private Long id;
    private String name;
    private String password;
}

@Getter

作用:用于生成getters方法。

@Getter是Lombok框架中的一个注解,用于自动生成getter方法。

在Java开发中,我们经常需要为类的属性编写getter和setter方法。为了简化这个过程,Lombok框架提供了一个@Getter注解,可以自动生成getter方法。

使用@Getter注解非常简单,只需要在Java类上添加这个注解即可。在使用时,Lombok会根据类的属性自动生成对应的getter方法。如果需要生成setter方法,可以使用@Setter注解。

用例:

@Getter
public class User {
      private Long id;
      private String name;
      private Integer age;
}

@Slf4j

作用:用于简化日志记录。

@Slf4j是Lombok框架中的一个注解,用于在Java类中自动生成日志记录器。

在Java开发中,日志记录是非常重要的一环,可以帮助我们更好地了解程序的运行情况,从而更好地进行调试和优化。通常情况下,我们需要手动引入日志框架(如Log4j、SLF4J等)并编写相应的日志记录代码。这些代码可能会比较繁琐,而且容易出现错误。为了简化这个过程,Lombok框架提供了一个@Slf4j注解,可以在Java类中自动生成日志记录器。

使用@Slf4j注解非常简单,只需要在Java类中添加这个注解即可。在使用时,我们可以直接使用log变量来记录日志,而不需要再引入其他的日志框架

用例:

@Slf4j
public class MyService {
      public void doSomething() {
            log.debug("This is a debug message.");
            log.info("This is an info message.");
            log.error("This is an error message.");
      }
}

在这个例子中,我们定义了一个MyService类,并使用@Slf4j注解来自动生成日志记录器。然后,在doSomething()方法中,我们直接使用log变量来记录日志,而不需要再引入其他的日志框架。

需要注意的是,使用@Slf4j注解需要在编译器中安装Lombok插件,否则可能会出现编译错误。另外,虽然@Slf4j注解非常方便,但在实际应用中,我们还需要根据实际情况选择合适的日志框架,并编写相应的日志记录代码。

总之,@Slf4j是Lombok框架中的一个注解,可以在Java类中自动生成日志记录器,从而简化日志记录的过程。它是一种极为方便的解决方案,可以提高应用程序的可维护性和可读性。

相关文章

JavaScript2024新功能:Object.groupBy、正则表达式v标志
PHP trim 函数对多字节字符的使用和限制
新函数 json_validate() 、randomizer 类扩展…20 个PHP 8.3 新特性全面解析
使用HTMX为WordPress增效:如何在不使用复杂框架的情况下增强平台功能
为React 19做准备:WordPress 6.6用户指南
如何删除WordPress中的所有评论

发布评论