Spring Boot中使用Spring-data-jpa让数据访问更简单、更优雅

在实际开发过程中，对数据库的操作无非就“增删改查”。就最为普遍的单表操作而言，除了表和字段不同外，语句都是类似的，开发人员需要写大量类似而枯燥的语句来完成业务逻辑。

为了解决这些大量枯燥的数据操作语句，我们第一个想到的是使用ORM框架，比如：Hibernate。通过整合Hibernate之后，我们以操作Java实体的方式最终将数据改变映射到数据库表中。

为了解决抽象各个Java实体基本的“增删改查”操作，我们通常会以泛型的方式封装一个模板Dao来进行抽象简化，但是这样依然不是很方便，我们需要针对每个实体编写一个继承自泛型模板Dao的接口，再编写该接口的实现。虽然一些基础的数据访问已经可以得到很好的复用，但是在代码结构上针对每个实体都会有一堆Dao的接口和实现。

由于模板Dao的实现，使得这些具体实体的Dao层已经变的非常“薄”，有一些具体实体的Dao实现可能完全就是对模板Dao的简单代理，并且往往这样的实现类可能会出现在很多实体上。Spring-data-jpa的出现正可以让这样一个已经很“薄”的数据访问层变成只是一层接口的编写方式。比如，下面的例子：

我们只需要通过编写一个继承自JpaRepository的接口就能完成数据访问，下面以一个具体实例来体验Spring-data-jpa给我们带来的强大功能。

使用示例

由于Spring-data-jpa依赖于Hibernate。如果您对Hibernate有一定了解，下面内容可以毫不费力的看懂并上手使用Spring-data-jpa。如果您还是Hibernate新手，您可以先按如下方式入门，再建议回头学习一下Hibernate以帮助这部分的理解和进一步使用。

工程配置

在pom.xml中添加相关依赖，加入以下内容：

{% highlight null %}

创建实体

创建一个User实体，包含id（主键）、name（姓名）、age（年龄）属性，通过ORM框架其会被映射到数据库表中，由于配置了hibernate.hbm2ddl.auto，在应用启动的时候框架会自动去数据库中创建对应的表。

{% highlight java %}

package com.xuying.demo.entity;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Entity
public class User {
@Id
@GeneratedValue
private Long id;
@Column(nullable = false)
private String name;
@Column(nullable = false)
private Integer age;

public User() {

}

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

public Long getId() {
    return id;
}

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

public String getName() {
    return name;
}

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

public Integer getAge() {
    return age;
}

public void setAge(Integer age) {
    this.age = age;
}

}

{% endhighlight %}

创建数据访问接口

下面针对User实体创建对应的Repository接口实现对该实体的数据访问，如下代码：

{% highlight java %}
package com.xuying.demo.repository;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;

import com.xuying.demo.entity.User;

public interface UserRepository extends JpaRepository

单元测试

在完成了上面的数据访问接口之后，按照惯例就是编写对应的单元测试来验证编写的内容是否正确。这里就不多做介绍，主要通过数据操作和查询来反复验证操作的正确性。

{% highlight java %}

package com.xuying;

import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;

import com.xuying.demo.DemoApplication;
import com.xuying.demo.entity.User;
import com.xuying.demo.repository.UserRepository;

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@SpringBootTest
@SpringApplicationConfiguration(DemoApplication.class)
public class ApplicationTestsUser {
@Autowired
private UserRepository userRepository;

@Test
public void test() throws Exception {
    userRepository.deleteAll();
    // 创建10条记录
    userRepository.save(new User("AAA", 10));
    userRepository.save(new User("BBB", 20));
    userRepository.save(new User("CCC", 30));
    userRepository.save(new User("DDD", 40));
    userRepository.save(new User("EEE", 50));
    userRepository.save(new User("FFF", 60));
    userRepository.save(new User("GGG", 70));
    userRepository.save(new User("HHH", 80));
    userRepository.save(new User("III", 90));
    userRepository.save(new User("JJJ", 100));
    // 测试findAll, 查询所有记录
    Assert.assertEquals(10, userRepository.findAll().size());
    // 测试findByName, 查询姓名为FFF的User
    Assert.assertEquals(60, userRepository.findByName("FFF").getAge().longValue());
    // 测试findUser, 查询姓名为FFF的User
    Assert.assertEquals(60, userRepository.findUser("FFF").getAge().longValue());
    // 测试findByNameAndAge, 查询姓名为FFF并且年龄为60的User
    Assert.assertEquals("FFF", userRepository.findByNameAndAge("FFF", 60).getName());
    // 测试删除姓名为AAA的User
    userRepository.delete(userRepository.findByName("AAA"));
    // 测试findAll, 查询所有记录, 验证上面的删除是否成功
    Assert.assertEquals(9, userRepository.findAll().size());
}

}

{% endhighlight %}