spring之数据库

April 9, 2023

https://docs.spring.io/spring-framework/docs/current/reference/html/data-access.html

使用 JdbcTemplate

首先安装下面几个依赖

org.springframework:spring-context
org.springframework:spring-jdbc
jakarta.annotation:jakarta.annotation-api
com.zaxxer:HikariCP

java

@Configuration
@ComponentScan
@PropertySource("jdbc.properties") // classpath 下的 jdbc.properties 文件
public class AppConfig {

    @Value("${jdbc.url}")
    String jdbcUrl;

    @Value("${jdbc.username}")
    String jdbcUsername;

    @Value("${jdbc.password}")
    String jdbcPassword;

    @Bean
    DataSource createDataSource() {
        HikariConfig config = new HikariConfig();
        config.setJdbcUrl(jdbcUrl);
        config.setUsername(jdbcUsername);
        config.setPassword(jdbcPassword);
        config.addDataSourceProperty("autoCommit", "true");
        config.addDataSourceProperty("connectionTimeout", "5");
        config.addDataSourceProperty("idleTimeout", "60");
        return new HikariDataSource(config);
    }

    @Bean
    JdbcTemplate createJdbcTemplate(@Autowired DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }
}

上面主要是配置了 JdbcTemplate 对象，配置完成即可注入

java

@Component
public class UserService {
    @Autowired
    JdbcTemplate jdbcTemplate;
    ...
}

execute 方法是最基本的方法，下面获取 Connection 对象

java

public User getUserById(long id) {
    return jdbcTemplate.execute((Connection conn) -> {
        try (var ps = conn.prepareStatement("SELECT * FROM users WHERE id = ?")) {
            ps.setObject(1, id);
            try (var rs = ps.executeQuery()) {
                if (rs.next()) {
                    return new User(
                            rs.getLong("id"),
                            rs.getString("email"),
                            rs.getString("password"),
                            rs.getString("name"));
                }
                throw new RuntimeException("cannot find user by id");
            }
        }
    });
}

上面还需要通过操作 Connection 对象传入 sql 语句，下面的方法可以直接执行 sql 语句并获取 PreparedStatement 对象

java

public User getUserByName(String name) {
    return jdbcTemplate.execute("SELECT * FROM users WHERE name = ?", (PreparedStatement ps) -> {
        ps.setObject(1, name);
        try (var rs = ps.executeQuery()) {
            if (rs.next()) {
                return new User(
                        rs.getLong("id"),
                        rs.getString("email"),
                        rs.getString("password"),
                        rs.getString("name"));
            }
            throw new RuntimeException("cannot find user by id");
        }
    });
}

上面的方法还是需要操作 PreparedStatement 对象并手动设置占位处的值，下面又加以简化

java

public User getUserByEmail(String email) {
    // 返回值的类型可以是任意的
    return jdbcTemplate.queryForObject("SELECT * FROM users WHERE email = ?",
            (ResultSet rs, int rowNum) -> {
                return new User(
                        rs.getLong("id"),
                        rs.getString("email"),
                        rs.getString("password"),
                        rs.getString("name"));
            },
            email);
}

通过 spring 提供的 BeanPropertyRowMapper 对象，可以将数据库的记录自动转为 javaBean

java

// 注意返回值的类型
public List<User> getUsers(int pageIndex) {
    int limit = 100;
    int offset = limit * (pageIndex - 1);
    return jdbcTemplate.query("SELECT * FROM users LIMIT ? OFFSET ?",
            new BeanPropertyRowMapper<>(User.class),
            limit, offset);
}
// 如果列名与javaBean不一致，则需要手动指定别名
// SELECT id, email, office_address AS workAddress, name FROM users WHERE email = ?

jdbcTemplate 的 update 方法返回受影响的行数

java

public void updateUsername(User user, String name) {
    if (1 != jdbcTemplate.update("UPDATE users SET name = ? WHERE id = ?", name, user.getId())) {
        throw new RuntimeException("cannot find user by id");
    }
}

若插入时含有自增列，可以通过 GeneratedKeyHolder 对象取出

java

public User register(String email, String password, String name) {
    KeyHolder holder = new GeneratedKeyHolder();

    if (1 != jdbcTemplate.update(
        (conn) -> {
            var ps = conn.prepareStatement("INSERT INTO users(email, password, name) VALUES(?, ?, ?)",
                    Statement.RETURN_GENERATED_KEYS /** 此处指定要返回自增键 */);
            ps.setObject(1, email);
            ps.setObject(2, password);
            ps.setObject(3, name);
            return ps;
        }, holder /** 此处传入 GeneratedKeyHolder */)) {
        throw new RuntimeException("failed to insert");
    }
    // 取出自增值
    return new User(holder.getKey().longValue(), email, password, name);
}

声明式事务

https://www.liaoxuefeng.com/wiki/1252599548343744/1282383642886177

spring 提供的 DAO 模式

spring 提供了 JdbcDaoSupport 抽象类，其持有 jdbcTemplate 对象

java

public abstract class JdbcDaoSupport extends DaoSupport {

    private JdbcTemplate jdbcTemplate;

    public final void setJdbcTemplate(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
        initTemplateConfig();
    }

    public final JdbcTemplate getJdbcTemplate() {
        return this.jdbcTemplate;
    }

    ...
}

不过该类不会自动注入 jdbcTemplate 对象，而需要子类手动注入（如下）

java

@Component
@Transactional
public class UserDao extends JdbcDaoSupport {
    @Autowired
    JdbcTemplate jdbcTemplate;

    @PostConstruct
    public void init() {
        super.setJdbcTemplate(jdbcTemplate);
    }
}

可以自己实现一个自动注入的jdbcTemplate 对象的基类

java

`public abstract class AbstractDao extends JdbcDaoSupport {
    @Autowired
    private JdbcTemplate jdbcTemplate;

    @PostConstruct
    public void init() {
        super.setJdbcTemplate(jdbcTemplate);
    }
}

这样，直接继承该基类就免于每次都手动注入

Hibernate ORM

https://hibernate.org/orm/

Java Persistence API （JPA）

https://www.oracle.com/java/technologies/persistence-jsp.html

MyBatis

如果直接使用 Mybatis，参见文档：https://mybatis.org/mybatis-3/zh/index.html
下面是在 Spring 环境下使用，并且只通过注解创建 Mapper。

首先保证我们已经创建了 DataSource

java

@Configuration
@ComponentScan
@EnableTransactionManagement
@PropertySource("jdbc.properties")
public class AppConfig {
    @Bean
    DataSource createDataSource() { ... }
}

使用 MyBatis 需要创建 SqlSessionFactory，但在 Spring 中我们创建 SqlSessionFactoryBean
（在 @Configuration 类中配置）

java

@Bean
SqlSessionFactoryBean createSqlSessionFactoryBean(@Autowired DataSource dataSource) {
    var sqlSessionFactoryBean = new SqlSessionFactoryBean();
    sqlSessionFactoryBean.setDataSource(dataSource);
    return sqlSessionFactoryBean;
}

MyBatis 可以直接使用 Spring 管理的声明式事务。
因此，创建事务管理器和在 JDBC 中创建事务管理器是完全一样的。

java

@Bean
PlatformTransactionManager createTxManager(@Autowired DataSource dataSource) {
    return new DataSourceTransactionManager(dataSource);
}

完成需要的配置后，就可以通过 MyBatis 来创建 Mapper 了

注解文档参见：https://mybatis.org/mybatis-3/zh/java-api.html#%E6%98%A0%E5%B0%84%E5%99%A8%E6%B3%A8%E8%A7%A3

java

public interface UserMapper {
    // 使用 @Select 注解
    @Select("SELECT * FROM users WHERE id = #{id}")
    User getById(@Param("id") long id);

    @Select("SELECT * FROM users LIMIT #{offset}, #{maxResults}")
    List<User> getAll(@Param("offset") int offset, @Param("maxResults") int maxResults);

    // 使用 @Insert 注解
    @Insert("INSERT INTO users (email, password, name, createdAt) VALUES (#{user.email}, #{user.password}, #{user.name}, #{user.createdAt})")
    void insert(@Param("user") User user);

    // 自增主键，我们希望不用传入。使用 @Options 注解
    // keyProperty=JavaBean属性
    // keyColumn=数据库主键列名
    @Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id")
    @Insert("INSERT INTO users (email, password, name, createdAt) VALUES (#{user.email}, #{user.password}, #{user.name}, #{user.createdAt})")
    void insert(@Param("user") User user);

    @Update("UPDATE users SET name = #{user.name}, createdAt = #{user.createdAt} WHERE id = #{user.id}")
    void update(@Param("user") User user);

    @Delete("DELETE FROM users WHERE id = #{id}")
    void deleteById(@Param("id") long id);
}

写好接口之后，我们通过 @MapperScan 注解让 Mybatis 自动创建对应实现类。

java

// 其它注解...
@MapperScan("com.example.demo")
public class AppConfig {
    ...
}

这样我们就可以在 Service 层直接注入 Mapper 接口了

java

@Component
@Transactional
public class UserService {
    @Autowired
    UserMapper userMapper;

    public User getUserById(long id) {
        User user = userMapper.getById(id);
        if (user == null) throw new RuntimeException("User not found by id.");
        return user;
    }
}

←Back to home