【Spring Framework】使用完全注解方式开发

cangloe2024-07-31 14:01

Spring Framework 是一个非常灵活且强大的 Java 企业级开发框架，它允许开发人员以多种方式进行配置和开发。在现代 Java 开发中，使用完全注解的方式来进行配置和开发已经成为趋势，这种方式能够减少 XML 配置文件的使用，使代码更加简洁和易于维护。

在本文中，我将详细介绍如何使用 Spring 的注解配置来进行完全注解化开发，包括如何定义 Bean、管理依赖注入、配置数据库、实现 AOP、处理事务等方面。

1. 完全注解配置的优点

完全注解配置有许多优点：

  • 减少 XML 依赖：不再需要繁琐的 XML 配置文件，所有配置都可以在 Java 类中通过注解完成。
  • 提高可读性和可维护性：配置更加紧凑，易于阅读和维护。
  • 类型安全：利用 Java 类型系统进行配置，减少配置错误。
  • 更好的 IDE 支持：IDE 对注解提供了良好的自动补全和重构支持。
  • 便于测试：配置类可以通过单元测试进行独立验证。

2. 基本注解和概念

在 Spring 中，注解可以用来定义和配置 Bean，以及实现自动装配、事务管理等功能。以下是一些常用的注解：

  • @Configuration：用于定义配置类，该类可以替代 XML 配置文件。
  • @Bean：用于定义 Bean，返回的对象会被注册为 Spring 应用上下文中的一个 Bean。
  • @Component 、@Service 、@Repository 、@Controller：用于自动扫描并注册为 Spring Bean，分别用于不同层次的组件（通用组件、服务层、持久层和控制层）。
  • @Autowired：用于自动装配 Bean，可以作用于字段、构造器或方法上。
  • @Qualifier ：与 @Autowired 一起使用，用于明确指定注入的 Bean。
  • @Value：用于注入属性值。
  • @PropertySource：指定外部属性文件的位置。
  • @EnableTransactionManagement：启用注解驱动的事务管理。
  • @Transactional：用于标记事务边界。
  • @EnableAspectJAutoProxy：启用基于注解的 AOP 支持。

3. 创建一个简单的 Spring 项目

为了演示完全注解化配置开发，我们将创建一个简单的 Spring 项目，包括以下几个模块：

  1. 配置类。
  2. 数据库连接和数据访问层。
  3. 服务层。
  4. 控制器层。
  5. AOP 和事务管理。

3.1 项目结构

src/main/java
|-- com.example
    |-- config
        |-- AppConfig.java
        |-- DataSourceConfig.java
        |-- WebConfig.java
    |-- model
        |-- User.java
    |-- repository
        |-- UserRepository.java
        |-- UserRepositoryImpl.java
    |-- service
        |-- UserService.java
        |-- UserServiceImpl.java
    |-- controller
        |-- UserController.java
    |-- aop
        |-- LoggingAspect.java
    |-- Application.java

3.2 配置类

3.2.1 AppConfig.java

AppConfig 是主配置类，启用组件扫描和其他核心功能。

java 复制代码 
package com.example.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.context.annotation.PropertySource;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@Configuration
@ComponentScan(basePackages = "com.example") // 扫描com.example包下的所有组件
@EnableTransactionManagement // 启用事务管理
@EnableAspectJAutoProxy // 启用AOP代理
@PropertySource("classpath:application.properties") // 加载属性文件
public class AppConfig {
    // AppConfig 是项目的核心配置类，不包含具体的 Bean 定义
}
3.2.2 DataSourceConfig.java

DataSourceConfig 用于配置数据源和 JdbcTemplate。

java 复制代码 
package com.example.config;

import org.apache.commons.dbcp2.BasicDataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;

import javax.sql.DataSource;

@Configuration
public class DataSourceConfig {

    @Bean
    public DataSource dataSource() {
        BasicDataSource dataSource = new BasicDataSource();
        dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/mydatabase?useSSL=false&serverTimezone=UTC");
        dataSource.setUsername("root");
        dataSource.setPassword("password");

        // 可选配置
        dataSource.setInitialSize(5);
        dataSource.setMaxTotal(10);
        dataSource.setMaxIdle(5);
        dataSource.setMinIdle(2);

        return dataSource;
    }

    @Bean
    public JdbcTemplate jdbcTemplate(DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }

    @Bean
    public PlatformTransactionManager transactionManager(DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
}
3.2.3 WebConfig.java

如果你正在使用 Spring MVC，则可以使用 WebConfig 来配置 DispatcherServlet、视图解析器等。

java 复制代码 
package com.example.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ViewResolverRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.view.InternalResourceViewResolver;

@Configuration
@EnableWebMvc // 启用Spring MVC
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix("/WEB-INF/views/");
        resolver.setSuffix(".jsp");
        registry.viewResolver(resolver);
    }

    // 可以在这里添加更多的 MVC 配置
}

3.3 模型类

创建一个简单的 User 模型类。

java 复制代码 
package com.example.model;

public class User {
    private int id;
    private String name;
    private String email;

    // 构造函数
    public User() {}

    public User(int id, String name, String email) {
        this.id = id;
        this.name = name;
        this.email = email;
    }

    // Getter 和 Setter
    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    @Override
    public String toString() {
        return "User{" +
               "id=" + id +
               ", name='" + name + '\'' +
               ", email='" + email + '\'' +
               '}';
    }
}

3.4 数据访问层

创建 UserRepository 接口和 UserRepositoryImpl 实现类，使用 JdbcTemplate 进行数据库操作。

3.4.1 UserRepository.java
java 复制代码 
package com.example.repository;

import com.example.model.User;
import java.util.List;

public interface UserRepository {
    void insertUser(User user);
    void updateUser(User user);
    void deleteUser(int id);
    User findUserById(int id);
    List<User> findAllUsers();
}
3.4.2 UserRepositoryImpl.java
java 复制代码 
package com.example.repository;

import com.example.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Repository;

import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;

@Repository
public class UserRepositoryImpl implements UserRepository {

    @Autowired
    private JdbcTemplate jdbcTemplate;

    @Override
    public void insertUser(User user) {
        String sql = "INSERT INTO users (name, email) VALUES (?, ?)";
        jdbcTemplate.update(sql, user.getName(), user.getEmail());
    }

    @Override
    public void updateUser(User user) {
        String sql = "UPDATE users SET name = ?, email = ? WHERE id = ?";
        jdbcTemplate.update(sql, user.getName(), user.getEmail(), user.getId());
    }

    @Override
    public void deleteUser(int id) {
        String sql = "DELETE FROM users WHERE id = ?";
        jdbcTemplate.update(sql, id);
    }

    @Override
    public User findUserById(int id) {
        String sql = "SELECT * FROM users WHERE id = ?";
        return jdbcTemplate.queryForObject(sql, new Object[]{id}, this::mapRowToUser);
    }

    @Override
    public List<User> findAllUsers() {
        String sql = "SELECT * FROM users";
        return jdbcTemplate.query(sql, this::mapRowToUser);
    }

    private User mapRowToUser(ResultSet rs, int rowNum) throws SQLException {
        return new User

(
            rs.getInt("id"),
            rs.getString("name"),
            rs.getString("email")
        );
    }
}

3.5 服务层

创建 UserService 接口和 UserServiceImpl 实现类，使用注解配置事务管理。

3.5.1 UserService.java
java 复制代码 
package com.example.service;

import com.example.model.User;

import java.util.List;

public interface UserService {
    void registerUser(User user);
    void modifyUser(User user);
    void removeUser(int id);
    User getUserById(int id);
    List<User> listAllUsers();
}
3.5.2 UserServiceImpl.java
java 复制代码 
package com.example.service;

import com.example.model.User;
import com.example.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserRepository userRepository;

    @Override
    @Transactional
    public void registerUser(User user) {
        userRepository.insertUser(user);
    }

    @Override
    @Transactional
    public void modifyUser(User user) {
        userRepository.updateUser(user);
    }

    @Override
    @Transactional
    public void removeUser(int id) {
        userRepository.deleteUser(id);
    }

    @Override
    public User getUserById(int id) {
        return userRepository.findUserById(id);
    }

    @Override
    public List<User> listAllUsers() {
        return userRepository.findAllUsers();
    }
}

3.6 控制器层

在控制器层中使用 @Controller 注解定义 Web 控制器。这里，我们将创建一个简单的控制器来展示如何处理请求。

3.6.1 UserController.java
java 复制代码 
package com.example.controller;

import com.example.model.User;
import com.example.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@Controller
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping
    public String listUsers(Model model) {
        List<User> users = userService.listAllUsers();
        model.addAttribute("users", users);
        return "user/list"; // 视图名称
    }

    @GetMapping("/{id}")
    public String getUser(@PathVariable int id, Model model) {
        User user = userService.getUserById(id);
        model.addAttribute("user", user);
        return "user/detail";
    }

    @PostMapping
    public String createUser(@ModelAttribute User user) {
        userService.registerUser(user);
        return "redirect:/users";
    }

    @PutMapping("/{id}")
    public String updateUser(@PathVariable int id, @ModelAttribute User user) {
        user.setId(id);
        userService.modifyUser(user);
        return "redirect:/users/" + id;
    }

    @DeleteMapping("/{id}")
    public String deleteUser(@PathVariable int id) {
        userService.removeUser(id);
        return "redirect:/users";
    }
}

3.7 AOP 切面编程

在 Spring 中，AOP（Aspect-Oriented Programming）允许我们将横切关注点（如日志记录、事务管理、权限检查等）从业务逻辑中分离出来。这里，我们将创建一个简单的日志切面。

3.7.1 LoggingAspect.java
java 复制代码 
package com.example.aop;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LoggingAspect {

    private static final Logger logger = LoggerFactory.getLogger(LoggingAspect.class);

    @Before("execution(* com.example.service.UserService.*(..))")
    public void logBefore(JoinPoint joinPoint) {
        logger.info("执行方法: " + joinPoint.getSignature().getName());
    }

    @AfterReturning(pointcut = "execution(* com.example.service.UserService.*(..))", returning = "result")
    public void logAfterReturning(JoinPoint joinPoint, Object result) {
        logger.info("方法返回: " + joinPoint.getSignature().getName() + "，返回值: " + result);
    }
}

3.8 启动类

最后，创建一个启动类来运行 Spring 应用程序。

3.8.1 Application.java
java 复制代码 
package com.example;

import com.example.config.AppConfig;
import com.example.service.UserService;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Application {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);

        UserService userService = context.getBean(UserService.class);

        // 添加用户
        userService.registerUser(new User(1, "Alice", "alice@example.com"));

        // 列出所有用户
        userService.listAllUsers().forEach(System.out::println);

        // 查找用户
        User user = userService.getUserById(1);
        System.out.println("查找到的用户: " + user);

        // 更新用户
        user.setName("Alice Updated");
        userService.modifyUser(user);

        // 删除用户
        userService.removeUser(1);

        context.close();
    }
}

4. 总结

本文介绍了如何使用 Spring 完全注解化的方式来进行开发。通过使用注解，我们可以减少 XML 配置文件的使用，使项目的配置更加直观和简洁。以下是本文的主要内容：

  • 配置类 ：使用 @Configuration、@Bean、@ComponentScan 等注解定义配置类。
  • 数据库配置 ：使用 DataSource、JdbcTemplate 以及 @Autowired 自动装配数据源。
  • 服务层和控制器层 ：使用 @Service 和 @Controller 注解定义业务逻辑和控制器，并使用 @Autowired 注入依赖。
  • AOP 和事务管理 ：通过 @Aspect 和 @Transactional 注解实现日志记录和事务管理。

这种完全注解化的开发方式在 Spring Boot 中得到了进一步的增强和推广，成为现代 Java 开发的主流方式。

相关推荐
qmx_078 分钟前
HTB-Jerry(tomcat war文件、msfvenom)
java·web安全·网络安全·tomcat
为风而战16 分钟前
IIS+Ngnix+Tomcat 部署网站 用IIS实现反向代理
java·tomcat
kejijianwen1 小时前
JdbcTemplate常用方法一览AG网页参数绑定与数据寻址实操
服务器·数据库·oracle
编程零零七1 小时前
Python数据分析工具(三)：pymssql的用法
开发语言·前端·数据库·python·oracle·数据分析·pymssql
技术无疆2 小时前
快速开发与维护：探索 AndroidAnnotations
android·java·android studio·android-studio·androidx·代码注入
高兴就好(石4 小时前
DB-GPT部署和试用
数据库·gpt
这孩子叫逆5 小时前
6. 什么是MySQL的事务？如何在Java中使用Connection接口管理事务？
数据库·mysql
Karoku0665 小时前
【网站架构部署与优化】web服务与http协议
linux·运维·服务器·数据库·http·架构
码农郁郁久居人下5 小时前
Redis的配置与优化
数据库·redis·缓存
架构文摘JGWZ5 小时前
Java 23 的12 个新特性！！
java·开发语言·学习
热门推荐
01RAG 实践- Ollama+RagFlow 部署本地知识库02组基轨迹建模 GBTM的介绍与实现（Stata 或 R）032024年高教社杯数学建模国赛C题超详细解题思路分析04Coze扣子平台完整体验和实践（附国内和国际版对比）05苍穹外卖面试总结06【2024数模国赛赛题思路公开】国赛B题思路丨附可运行代码丨无偿自提07yolov8实战第五天——yolov8+ffmpg实时视频流检测并进行实时推流——（推流，保姆教学）08CCF-CSP认证考试 202406-3 文本分词 100分题解09【2024高教社杯全国大学生数学建模竞赛】B题 生产过程中的决策问题——解题思路 代码 论文10浏览器插件——ModHeader 的分享和学习