Spring使用（一）注解

Spring使用

资源

Spring 框架内部使用 Resource 接口作为所有资源的抽象和访问接口，在上一篇文章的示例代码中的配置文件是通过ClassPathResource 进行封装的，ClassPathResource 是 Resource 的一个特定类型的实现，代表的是位于 classpath 中的资源。

对不同来源的资源文件 Spring 都提供了相应的实现：文件（FileSystemResource ）、ClassPath资源（ClassPathResource）、URL资源（UrlResource）、InputStream资源（InputStreamResource）、ByteArray资源（ByteArrayResource）等。

注解

spring mvc注解.png

宏观：

①Service

@Service 注解是用来声明服务层(Service Layer)组件，通常包含业务逻辑，作为数据访问层(Data Access Layer)和控制器(Controller Layer)之间的桥梁。

它是一个立即加载的注解，这意味着当 Spring 应用程序启动时，Spring 容器就会创建标注了 @Service 的类的实例。
@Service 是一个特殊类型的 @Component 注解。它允许自动检测通过类路径扫描，为其创建 Bean 定义并注册到 Spring 容器中。
它有助于区分 Spring 组件的表示层(Controller)、服务层(Service)和数据访问层(Repository)。

②Controller

用于标记一个类作为 Spring MVC 控制器组件。控制器负责处理由 DispatcherServlet 分发的来自浏览器或其他客户端的 HTTP 请求。这个注解会将类识别为一个 Bean，并注册到 Spring 应用上下文中。

通常与 @RequestMapping 或其他基于 HTTP 方法的注解(@GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping)配合使用，以定义访问该控制器方法的 URL 模式和请求类型。
允许通过依赖注入引入其他层级的服务或组件，比如服务层 (@Service) 或数据访问层 (@Repository)。
与视图技术（如 Thymeleaf、JSP 等）协同工作，可以返回 String 类型的视图名，由视图解析器进一步处理。
当使用 Spring Boot 和 RESTful Web 服务时，通常会结合 @RestController 注解来使用，它是 @Controller 和 @ResponseBody 的组合体，这意味着控制器的所有响应默认都会转换成 JSON 或 XML 格式返回给客户端。

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.ui.Model;

@Controller
public class MyController {

    @RequestMapping("/greet")
    public String greet(Model model) {
        model.addAttribute("message", "Hello, World!");
        return "greeting"; // 返回视图名称，通常是一个 HTML 页面
    }
}

③Repository

用于标识持久层组件（如DAO组件）的特殊化 @Component 注解。当你在类上使用 @Repository 注解时，它会告知 Spring 容器该类是一个 Bean，并且用于封装数据访问异常，将底层数据访问技术抛出的异常转换为 Spring 的 DataAccessException。

// 告诉Spring，让Spring创建一个名字叫“userDao”的UserDaoImpl实例。
@Repository(value="userDao")
public class UserDaoImpl extends BaseDaoImpl<User> {
………
}

// 注入userDao，从数据库中根据用户Id取出指定用户时需要用到
@Resource(name = "userDao")
private BaseDao<User> userDao;

④Configuration

@Configuration 是表明某个类是用来作为 bean 定义的源的。被 @Configuration 注解的类通常包含了一个或多个标记有 @Bean 注解的方法。Spring 容器会在运行时自动调用这些方法，将返回对象注册为容器中的 bean。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    @Bean
    public MyService myService() {
        return new MyServiceImpl();
    }
}
// AppConfig 类被标注为 @Configuration，这意味着它可以包含 bean 定义。myService 方法上的 @Bean 注解告诉 Spring，这个方法将返回一个对象，该对象需要被注册为应用程序上下文中的一个 bean。默认情况下，bean 的名称与方法名相同，但可以通过 @Bean 注解的 name 属性来自定义。

// 这种配置方式实现了代码的模块化，并且取代了传统的 XML 配置文件，使得配置更加清晰和类型安全

⑤Resource

@Resource 默认按照 by-name 自动装配，即根据 bean 的名称进行匹配；如果没有找到与名称匹配的 bean，则会退回到 by-type 自动装配（首先尝试依据属性名作为 bean 名称查找，如果失败则按类型装配）。而 @Autowired 默认按照 by-type 自动装配。
@Resource 所标注的自动装配过程是在 bean 属性设置完成之后、初始化方法（如 @PostConstruct 注解的方法）之前进行的，而 @Autowired 则是在构造器、字段、setter 方法或其他任意带有参数的方法上使用。

import javax.annotation.Resource;
@Component
public class MyComponent {
    // By name
    @Resource(name = "myBean")
    private MyBean myBeanByName;

    // By type (当存在多个相同类型的 bean 时，可能需要指定 name 来避免冲突)
    @Resource
    private MyBean myBeanByType;

    public void doSomething() {
        // 使用 myBeanByName 和 myBeanByType 完成一些操作...
    }
}
// @Resource 注解有两个重要的属性：name 和 type：
name: 指定要注入的 bean 的名称。
type: 指定要注入的 bean 的类型。

微观

① Async：将方法标注为异步执行

在一个普通的方法或者类中调用了由 @Async 注解标记的方法，那么当前线程会立即返回，而实际执行的过程会在另外的线程中进行，当前线程将继续执行自身的任务。

@Service
public class MyService {
  
  @Autowired
  private EmailService emailService;

  @Async
  public void sendEmails(List<String> recipients, String content) {

    for (String recipient : recipients) {
      emailService.sendEmail(recipient, content);
    }

    System.out.println("All emails sent!");
  }
}

②Autowired：自动装配依赖的 bean。

@Autowired 注解是 Spring Framework 中的一个依赖注入注解，它可以自动将容器中已经创建好的 bean 对象装配到需要他们的类或者方法中。默认先按byType进行匹配，如果发现找到多个bean，则又按照byName方式进行匹配，如果还有多个，则报出异常

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class MyComponent {

    private final Dependency dependency;

    // 构造器注入，如果容器中不存在Dependency类型的Bean，应用将无法启动
    @Autowired(required = true)
    public MyComponent(Dependency dependency) {
        this.dependency = dependency;
    }
    
    // 如果容器中不存在OptionalDependency类型的Bean，则dependency字段将为null，但应用依旧会启动
    @Autowired(required = false)
    private OptionalDependency optionalDependency;
}

③Bean：声明一个需要被 Spring 管理的 bean

@Configuration // 添加了 @Configuration 注解来标识这是一个配置类，因此 Spring 容器在扫描时会识别并加载该类。
public class MyConfiguration {
  @Bean
  public UserDao userDao() {
    return new JdbcUserDao(dataSource());
  }
  @@Bean(“myBean”) // 这样可以在装配其他依赖项时方便地引用该 bean 对象。
  public DataSource dataSource() {
    // 创建并配置数据源对象
    return new HikariDataSource(config);
  }
}

在上面的代码中，我们定义了一个配置类 MyConfiguration，并在其中定义了两个 bean 对象：userDao() 和 dataSource()。其中 userDao() 方法返回 JdbcUserDao 对象，而 dataSource() 方法返回一个 Hikari 数据源对象。这两个方法都标记了 @Bean 注解，这意味着它们会被 Spring 容器扫描到并将创建的对象注册到容器中。

④Cacheable：增加缓存支持

@Cacheable 是 Spring Framework 中的一个注解，用于实现方法级别的缓存。使用 @Cacheable 注解的方法在调用时，将会检查缓存中是否存在与该方法所需参数相对应的缓存项。如果存在，则直接返回缓存结果，不再执行被注解的方法；如果不存在，则执行该方法，并将方法的返回结果添加到缓存中。

@Service
public class UserService {

  private final UserMapper userMapper;

  public UserService(UserMapper userMapper) {
    this.userMapper = userMapper;
  }

  @Cacheable(value = "users", key = "#userId")
  public User getUserById(int userId) {
    return userMapper.getUserById(userId);
  }

}

⑤ Conditional

Conditional用于根据特定条件动态决定是否创建某个 Bean 实例，Spring 还提供了一些预定义的条件注解，如 @Profile、@ConditionalOnMissingClass、@ConditionalOnProperty 等，它们可以方便地满足一些常见的判断场景，减少了编写自定义条件类的工作量。

@Configuration
public class MyConfiguration {
  @Bean
  @Conditional(MyCondition.class)
  public MyBean myBean() {
    return new MyBean();
  }
}

public class MyCondition implements Condition {
  @Override
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    // TODO: 自定义条件判断逻辑
    return true; // 当结果为 true 时，表示条件成立，按照要求创建 Bean；否则，则不会创建这个 Bean。
  }
}

使用 @Profile 注解可以确保只有相关的 beans 在特定的环境配置下被创建，这样可以避免在不适合的环境中运行可能引起冲突或异常的 beans，并有助于维护清晰的环境特定配置。
@Profile("development")
@Profile("production")

根据设置系统属性: -Dspring.profiles.active=development
或者使用环境变量设置 SPRING_PROFILES_ACTIVE=development等来切换profile

⑥ConstructorBinding

用于表示在使用基于构造器的依赖注入时，应该将配置属性绑定到构造器参数上

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.ConstructorBinding;

@ConstructorBinding
@ConfigurationProperties(prefix = "app") //指定哪个前缀的配置属性应被绑定到该类的字段上,Spring Boot 将会查找 app.name 和 app.threadPoolSize 配置项，并通过构造器自动注入相应的值。
public class AppConfigProperties {

    private final String name;
    private final int threadPoolSize;

    public AppConfigProperties(String name, int threadPoolSize) {
        this.name = name;
        this.threadPoolSize = threadPoolSize;
    }

    // Getters for the fields
    public String getName() {
        return name;
    }

    public int getThreadPoolSize() {
        return threadPoolSize;
    }
}

⑦ControllerAdvice

@ControllerAdvice 是 Spring MVC 框架中的注解，用于定义一个全局性的异常处理器类。可以对 Controller 层面和全局异常进行统一的处理。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler({NullPointerException.class, IllegalArgumentException.class}) //当捕获到空指针异常或者非法参数异常时，会执行这个方法，将异常信息添加到 request 中，并返回 “error” 视图。
    public String handleException(Exception e, HttpServletRequest request) {
        request.setAttribute("error", e);
        return "error";
    }
}

⑧CrossOrigin

同源策略阻止一个域下的文档或脚本与另一个域下的资源进行交互。这有助于保护用户免受恶意网站的攻击，但也限制了合法的跨源请求。

例如，如果你的页面在 https://www.example.com 上运行，而尝试通过 AJAX 请求从 https://api.another-site.com 获取数据，这将被默认视为跨域请求，并可能遭到浏览器的阻止，除非目标服务器明确允许来自原始域的请求。

@RestController
@RequestMapping("/api")
public class ApiController {

    @CrossOrigin(origins = "http://localhost:8080")
    @GetMapping("/users/{id}")
    public User getUserById(@PathVariable Long id) {
        // ...
    }
}

⑨EnableAsync

在处理一些 IO 密集型操作时，非常有用

@Configuration
@EnableAsync // @EnableAsync 注解需要与异步方法搭配使用，异步方法需要用 @Async 标记。
public class AppConfig {

    @Bean
    public Executor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(20);
        executor.setQueueCapacity(30);
        executor.initialize();
        return executor;
    }
}

⑩RequestMapping

@RequestMapping 的专门化版本提供了更简洁的语法。这些包括 @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping。每个都对应于一个 HTTP 方法，使得代码更加简洁易读。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("/api")
public class MyController {

    @GetMapping("/hello") // 等同于 @RequestMapping(value = "/hello", method = GET)
    @ResponseBody
    public String helloWorld() {
        return "Hello, World!";
    }

    @PostMapping("/submit") // 等同于 @RequestMapping(value = "/submit", method = POST)
    @ResponseBody
    public String submitForm() {
        // 方法实现
        return "Form submitted";
    }
}

其他

①lazy

@Lazy 是 Spring 框架中的注解之一，它用于控制 Bean 的实例化时间。通过在容器中标记一个 Bean 为 @Lazy，可以让 Spring 容器在第一次使用这个 Bean 时再进行实例化。相对应的，如果不加 @Lazy 注解，则默认情况下 Spring 容器会在启动时就实例化该 Bean。

@Service
@Lazy // 使用 @Lazy 注解，Spring 容器将在第一次使用 UserService 的实例时才进行实例化而不是在启动时就实例化
public class UserService {
    // ...
}

②Import

允许我们在一个配置类中引入其他配置类或普通的 Java 类

@Configuration
@Import({DataSourceConfig.class, RedisConfig.class, ServiceUtils.class})
public class AppConfig {
    // ...
}
// 在创建 Spring ApplicationContext 时，这三个配置类都会被加载并注册为 Spring 的 bean。
// 可以在 AppConfig 中使用 ServiceUtils 类中的方法或属性

③元注解

@Target：指定注解可以应用于 Java 的哪些元素（如类、方法、字段等）。
@Retention：指定注解在什么级别可用（源码、类文件或运行时）。
@Documented：指定注解是否应该被 javadoc 工具记录。
@Inherited：指定注解是否可以被子类继承。
@Component：Spring 特有的元注解，用于声明一个类是 Spring 组件。其它注解如 @Service, @Repository, @Controller 都是用 @Component 注解的例子。

④Valid

在控制器方法的参数列表中使用 @Valid （ @NotNull、@Min、@Max、@Size、@Email…）注解来实现请求参数的校验。

@RestController
@RequestMapping("/users")
public class UserController {
    @PostMapping
    public User createUser(@Valid @RequestBody User user) {
        // 保存用户信息到数据库
    }

    // ...
}

// 校验的规则通常定义在 User 类的属性上
public class User {
    @NotBlank
    private String username;

    @Pattern(regexp = "^[a-zA-Z0-9]+@[a-zA-Z0-9]+\\.[a-zA-Z]{2,}$", message = "Email 格式错误")
    private String email;
}

第三方

@Data

@Data注解是Lombok库的一部分，非Spring框架本身的一部分。当你在一个类上使用@Data注解，Lombok会自动生成以下代码：
- 所有字段的getter方法
- 所有非最终字段的setter方法
- toString()方法
- equals()和hashCode()方法
- 一个包含所有非静态、非瞬态字段的构造函数
这大大减少了样板代码的数量，使得类的定义更加简洁

`@Mapper`

@Mapper注解是MyBatis框架的一部分，它主要用于标记一个接口作为数据库操作的映射接口。MyBatis通过这个接口关联XML配置文件或者注解中定义的数据库操作。

@Mapper
public interface UserMapper {
    User selectUserById(Long id);
}

// 在Spring Boot项目中，通常还会配合使用@MapperScan注解来指定需要扫描的@Mapper接口所在的包路径。
@SpringBootApplication
@MapperScan("com.example.project.mapper")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Spring使用

资源

注解

宏观：

微观

其他

第三方

@Data

@Mapper

相关推荐

最近更新

热门阅读

`@Data`

`@Mapper`