全面指南：Spring 框架

Home PDF English

本博客文章由 ChatGPT-4o 协助编写。

简介
Spring Boot 框架
Spring 数据管理
构建 RESTful 服务
- Spring REST 客户端
- FeignClient
邮件、任务和调度
- 邮件支持
- 任务执行和调度
Spring 测试
- 使用 Mockito 进行测试
- 使用 MockMvc 进行测试
监控和管理
- Spring Boot Actuator
高级主题
- Spring Advice API
结论

简介

Spring 是构建企业级 Java 应用程序的最受欢迎的框架之一。它为开发 Java 应用程序提供了全面的基础设施支持。在本博客中，我们将介绍 Spring 生态系统的各个方面，包括 Spring Boot、数据管理、构建 RESTful 服务、调度、测试以及高级功能如 Spring Advice API。

Spring Boot 框架

Spring Boot 入门

Spring Boot 使创建独立的、生产级的 Spring 应用程序变得简单。它对 Spring 平台和第三方库采取了一种固执己见的看法，让你在最少配置的情况下快速上手。

初始设置：通过 Spring Initializr 创建一个新的 Spring Boot 项目。你可以选择所需的依赖项，如 Spring Web、Spring Data JPA 和 Spring Boot Actuator。
注解：了解关键注解，如 @SpringBootApplication，它是 @Configuration、@EnableAutoConfiguration 和 @ComponentScan 的组合。
嵌入式服务器：Spring Boot 使用嵌入式服务器（如 Tomcat、Jetty 或 Undertow）来运行应用程序，因此你不需要将 WAR 文件部署到外部服务器。

依赖注入

依赖注入（DI）是 Spring 的核心原则之一。它允许创建松耦合的组件，使代码更具模块化且更易于测试。

@Autowired：此注解用于自动注入依赖项。它可以应用于构造函数、字段和方法。Spring 的依赖注入功能会自动解析并注入协作的 bean。

字段注入示例：

@Component
public class UserService {
      
    @Autowired
    private UserRepository userRepository;
      
    // 业务方法
}

构造函数注入示例：

@Component
public class UserService {
      
    private final UserRepository userRepository;

    @Autowired
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
      
    // 业务方法
}

方法注入示例：

@Component
public class UserService {
      
    private UserRepository userRepository;

    @Autowired
    public void setUserRepository(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
      
    // 业务方法
}

@Component, @Service, @Repository：这些是 @Component 注解的特化版本，用于指示一个类是 Spring bean。它们也作为注解类所扮演角色的提示。
- @Component：这是任何 Spring 管理的组件的通用构造型。可以用来标记任何类为 Spring bean。
  
  示例：
```
@Component
public class EmailValidator {
        
    public boolean isValid(String email) {
        // 验证逻辑
        return true;
    }
}
```
- @Service：这是 @Component 的特化版本，用于标记一个类为服务。通常用于服务层，在那里实现业务逻辑。
  
  示例：
```
@Service
public class UserService {
        
    @Autowired
    private UserRepository userRepository;

    public User findUserById(Long id) {
        return userRepository.findById(id).orElse(null);
    }
}
```
- @Repository：这也是 @Component 的特化版本。用于指示该类提供对象的存储、检索、搜索、更新和删除操作的机制。它还将持久性异常转换为 Spring 的 DataAccessException 层次结构。
  
  示例：
```
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
    // 自定义查询方法
}
```

这些注解使你的 Spring 配置更加简洁易读，并帮助 Spring 框架管理和连接不同 bean 之间的依赖关系。

Spring 中的事件

Spring 的事件机制允许你创建和监听应用程序事件。

自定义事件：通过扩展 ApplicationEvent 创建自定义事件。例如：

public class MyCustomEvent extends ApplicationEvent {
    private String message;

    public MyCustomEvent(Object source, String message) {
        super(source);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

事件监听器：使用 @EventListener 或实现 ApplicationListener 来处理事件。例如：

@Component
public class MyEventListener {

    @EventListener
    public void handleMyCustomEvent(MyCustomEvent event) {
        System.out.println("接收到 Spring 自定义事件 - " + event.getMessage());
    }
}

发布事件：使用 ApplicationEventPublisher 发布事件。例如：

@Component
public class MyEventPublisher {
      
    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    public void publishCustomEvent(final String message) {
        System.out.println("发布自定义事件。 ");
        MyCustomEvent customEvent = new MyCustomEvent(this, message);
        applicationEventPublisher.publishEvent(customEvent);
    }
}

Spring 数据管理

Spring Data JDBC

Spring Data JDBC 提供简单有效的 JDBC 访问。

Repositories：定义仓库以执行 CRUD 操作。例如：

public interface UserRepository extends CrudRepository<User, Long> {
}

查询：使用 @Query 注解定义自定义查询。例如：

@Query("SELECT * FROM users WHERE username = :username")
User findByUsername(String username);

Spring Data JPA

Spring Data JPA 使实现基于 JPA 的仓库变得容易。

实体映射：使用 @Entity 定义实体并将它们映射到数据库表。例如：

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;
    private String password;
    // getters 和 setters
}

Repositories：通过扩展 JpaRepository 创建仓库接口。例如：

public interface UserRepository extends JpaRepository<User, Long> {
}

查询方法：使用查询方法执行数据库操作。例如：
```
List<User> findByUsername(String username);
```

Spring Data Redis

Spring Data Redis 提供了 Redis 数据访问的基础设施。

RedisTemplate：使用 RedisTemplate 与 Redis 交互。例如：

@Autowired
private RedisTemplate<String, Object> redisTemplate;

public void save(String key, Object value) {
    redisTemplate.opsForValue().set(key, value);
}

public Object find(String key) {
    return redisTemplate.opsForValue().get(key);
}

Repositories：使用 @Repository 创建 Redis 仓库。例如：

@Repository
public interface RedisRepository extends CrudRepository<RedisEntity, String> {
}

事务和 DAO 支持

Spring 简化了事务和 DAO（数据访问对象）支持的管理。

事务管理：使用 @Transactional 管理事务。例如：

@Transactional
public void saveUser(User user) {
  userRepository.save(user);
}

DAO 模式：实现 DAO 模式以分离持久性逻辑。例如：

public class UserDao {
    @Autowired
    private JdbcTemplate jdbcTemplate;

    public User findById(Long id) {
        return jdbcTemplate.queryForObject("SELECT * FROM users WHERE id = ?", new Object[]{id}, new UserRowMapper());
    }
}

JDBC 和 ORM

Spring 提供了全面的 JDBC 和 ORM（对象关系映射）支持。

JdbcTemplate：使用 JdbcTemplate 简化 JDBC 操作。例如：

@Autowired
private JdbcTemplate jdbcTemplate;

public List<User> findAll() {
    return jdbcTemplate.query("SELECT * FROM users", new UserRowMapper());
}

Hibernate：将 Hibernate 与 Spring 集成以提供 ORM 支持。例如：

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;
    private String password;
    // getters 和 setters
}

构建 RESTful 服务

Spring REST 客户端

Spring 使构建 RESTful 客户端变得简单。

RestTemplate：使用 RestTemplate 发起 HTTP 请求。例如：

@Autowired
private RestTemplate restTemplate;

public String getUserInfo(String userId) {
    return restTemplate.getForObject("https://api.example.com/users/" + userId, String.class);
}

WebClient：使用反应式 WebClient 进行非阻塞请求。例如：

@Autowired
private WebClient.Builder webClientBuilder;

public Mono<String> getUserInfo(String userId) {
    return webClientBuilder.build()
            .get()
            .uri("https://api.example.com/users/" + userId)
            .retrieve()
            .bodyToMono(String.class);
}

FeignClient

Feign 是一个声明式的 Web 服务客户端。

设置：将 Feign 添加到项目中，并创建带有 @FeignClient 注解的接口。例如：

@FeignClient(name = "user-service", url = "https://api.example.com")
public interface UserServiceClient {
    @GetMapping("/users/{id}")
    String getUserInfo(@PathVariable("id") String userId);
}

配置：使用拦截器和错误解码器自定义 Feign 客户端。例如：

@Bean
public RequestInterceptor requestInterceptor() {
    return requestTemplate -> requestTemplate.header("Authorization", "Bearer token");
}

邮件、任务和调度

邮件支持

Spring 提供发送邮件的支持。

JavaMailSender：使用 JavaMailSender 发送邮件。例如：

@Autowired
private JavaMailSender mailSender;

public void sendEmail(String to, String subject, String body) {
    SimpleMailMessage message = new SimpleMailMessage();
    message.setTo(to);
    message.setSubject(subject);
    message.setText(body);
    mailSender.send(message);
}

MimeMessage：创建带有附件和 HTML 内容的富邮件。例如：

@Autowired
private JavaMailSender mailSender;

public void sendRichEmail(String to, String subject, String body, File attachment) throws MessagingException {
    MimeMessage message = mailSender.createMimeMessage();
    MimeMessageHelper helper = new MimeMessageHelper(message, true);
    helper.setTo(to);
    helper.setSubject(subject);
    helper.setText(body, true);
    helper.addAttachment(attachment.getName(), attachment);
    mailSender.send(message);
}

任务执行和调度

Spring 的任务执行和调度支持使得运行任务变得简单。

@Scheduled：使用 @Scheduled 调度任务。例如：

@Scheduled(fixedRate = 5000)
public void performTask() {
    System.out.println("每 5 秒运行一次的调度任务");
}

异步任务：使用 @Async 异步运行任务。例如：

@Async
public void performAsyncTask() {
    System.out.println("后台运行的异步任务");
}

Spring 测试

使用 Mockito 进行测试

Mockito 是一个强大的模拟库，用于测试。

模拟依赖项：使用 @Mock 和 @InjectMocks 创建模拟对象。例如：

@RunWith(MockitoJUnitRunner.class)
public class UserServiceTest {
    @Mock
    private UserRepository userRepository;

    @InjectMocks
    private UserService userService;

    @Test
    public void testFindUserById() {
        User user = new User();
        user.setId(1L);
        Mockito.when(userRepository.findById(1L)).thenReturn(Optional.of(user));

        User result = userService.findUserById(1L);
        assertNotNull(result);
        assertEquals(1L, result.getId().longValue());
    }
}

行为验证：验证与模拟对象的交互。例如：

Mockito.verify(userRepository, times(1)).findById(1L);

使用 MockMvc 进行测试

MockMvc 允许你测试 Spring MVC 控制器。

设置：在测试类中配置 MockMvc。例如：

@RunWith(SpringRunner.class)
@WebMvcTest(UserController.class)
public class UserControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testGetUser() throws Exception {
        mockMvc.perform(get("/users/1"))
            .andExpect(status().isOk())
            .andExpect(content().contentType(MediaType.APPLICATION_JSON))
            .andExpect(jsonPath("$.id").value(1));
    }
}

请求构建器：使用请求构建器模拟 HTTP 请求。例如：

mockMvc.perform(post("/users")
    .contentType(MediaType.APPLICATION_JSON)
    .content("{\"username\":\"john\",\"password\":\"secret\"}"))
    .andExpect(status().isCreated());

监控和管理

Spring Boot Actuator

Spring Boot Actuator 提供了用于监控和管理应用程序的生产级功能。

端点：使用 /actuator/health 和 /actuator/metrics 等端点监控应用程序的健康状况和指标。例如：
```
curl http://localhost:8080/actuator/health
```

自定义端点：创建自定义的 Actuator 端点。例如：

@RestController
@RequestMapping("/actuator")
public class CustomEndpoint {
    @GetMapping("/custom")
    public Map<String, String> customEndpoint() {
        Map<String, String> response = new HashMap<>();
        response.put("status", "自定义 Actuator 端点");
        return response;
    }
}

高级主题

Spring Advice API

Spring 的 Advice API 提供了高级的 AOP（面向切面编程）功能。

@Aspect：使用 @Aspect 定义切面。例如：

@Aspect
@Component
public class LoggingAspect {
    @Before("execution(* com.example.service.*.*(..))")
    public void logBefore(JoinPoint joinPoint) {
        System.out.println("方法之前：" + joinPoint.getSignature().getName());
    }

    @After("execution(* com.example.service.*.*(..))")
    public void logAfter(JoinPoint joinPoint) {
        System.out.println("方法之后：" + joinPoint.getSignature().getName());
    }
}

连接点：使用连接点定义应应用切面的地方。例如：

@Pointcut("execution(* com.example.service.*.*(..))")
public void serviceMethods() {}

@Around("serviceMethods()")
public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
    System.out.println("方法之前：" + joinPoint.getSignature().getName());
    Object result = joinPoint.proceed();
    System.out.println("方法之后：" + joinPoint.getSignature().getName());
    return result;
}

结论

Spring 是一个功能强大且多功能的框架，可以简化企业级应用程序的开发。通过利用 Spring Boot、Spring Data、Spring REST 和其他 Spring 项目的功能，开发人员可以高效地构建健壮、可扩展和易维护的应用程序。借助 Spring Boot Actuator 和测试框架等工具，你可以确保你的应用程序已准备好投入生产并经过充分测试。

Back 2023.02.07 Donate