使用 SimpleJdbc 类简化 JDBC 操作

SimpleJdbcInsert 和 SimpleJdbcCall 类利用可通过 JDBC 驱动程序检索的数据库元数据提供简化的配置。这意味着您需要预先配置的内容较少，尽管如果您更喜欢在代码中提供所有详细信息，可以覆盖或关闭元数据处理。

使用 SimpleJdbcInsert 插入数据

我们首先从最少配置选项开始了解 SimpleJdbcInsert 类。您应该在数据访问层的初始化方法中实例化 SimpleJdbcInsert。对于此示例，初始化方法是 setDataSource 方法。您不需要对 SimpleJdbcInsert 类进行子类化。相反，您可以创建一个新实例并使用 withTableName 方法设置表名。此类的配置方法遵循返回 SimpleJdbcInsert 实例的 fluid 风格，这允许您链接所有配置方法。以下示例仅使用一个配置方法（稍后我们将展示多个方法的示例）

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcInsert insertActor;

	public void setDataSource(DataSource dataSource) {
		this.insertActor = new SimpleJdbcInsert(dataSource).withTableName("t_actor");
	}

	public void add(Actor actor) {
		Map<String, Object> parameters = new HashMap<>(3);
		parameters.put("id", actor.getId());
		parameters.put("first_name", actor.getFirstName());
		parameters.put("last_name", actor.getLastName());
		insertActor.execute(parameters);
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

	private val insertActor = SimpleJdbcInsert(dataSource).withTableName("t_actor")

	fun add(actor: Actor) {
		val parameters = mutableMapOf<String, Any>()
		parameters["id"] = actor.id
		parameters["first_name"] = actor.firstName
		parameters["last_name"] = actor.lastName
		insertActor.execute(parameters)
	}

	// ... additional methods
}

这里使用的 execute 方法接受一个普通的 java.util.Map 作为其唯一参数。需要注意的重要一点是，用于 Map 的键必须与数据库中定义的表列名匹配。这是因为我们读取元数据来构建实际的 insert 语句。

使用 SimpleJdbcInsert 检索自动生成的主键

下一个示例使用与上一个示例相同的插入，但它不是传入 id，而是检索自动生成的主键并将其设置在新的 Actor 对象上。当创建 SimpleJdbcInsert 时，除了指定表名，还使用 usingGeneratedKeyColumns 方法指定生成主键列的名称。以下列表显示了其工作原理

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcInsert insertActor;

	public void setDataSource(DataSource dataSource) {
		this.insertActor = new SimpleJdbcInsert(dataSource)
				.withTableName("t_actor")
				.usingGeneratedKeyColumns("id");
	}

	public void add(Actor actor) {
		Map<String, Object> parameters = new HashMap<>(2);
		parameters.put("first_name", actor.getFirstName());
		parameters.put("last_name", actor.getLastName());
		Number newId = insertActor.executeAndReturnKey(parameters);
		actor.setId(newId.longValue());
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

	private val insertActor = SimpleJdbcInsert(dataSource)
			.withTableName("t_actor").usingGeneratedKeyColumns("id")

	fun add(actor: Actor): Actor {
		val parameters = mapOf(
				"first_name" to actor.firstName,
				"last_name" to actor.lastName)
		val newId = insertActor.executeAndReturnKey(parameters);
		return actor.copy(id = newId.toLong())
	}

	// ... additional methods
}

使用这种第二种方法运行插入时的主要区别在于，您不需要将 id 添加到 Map 中，而是调用 executeAndReturnKey 方法。这会返回一个 java.lang.Number 对象，您可以使用它创建域类中使用的数字类型的实例。您不能指望所有数据库在这里都返回特定的 Java 类。java.lang.Number 是您可以依赖的基类。如果您有多个自动生成列或生成的值是非数值的，可以使用从 executeAndReturnKeyHolder 方法返回的 KeyHolder。

为 SimpleJdbcInsert 指定列

您可以使用 usingColumns 方法指定列名列表来限制插入的列，如下例所示

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcInsert insertActor;

	public void setDataSource(DataSource dataSource) {
		this.insertActor = new SimpleJdbcInsert(dataSource)
				.withTableName("t_actor")
				.usingColumns("first_name", "last_name")
				.usingGeneratedKeyColumns("id");
	}

	public void add(Actor actor) {
		Map<String, Object> parameters = new HashMap<>(2);
		parameters.put("first_name", actor.getFirstName());
		parameters.put("last_name", actor.getLastName());
		Number newId = insertActor.executeAndReturnKey(parameters);
		actor.setId(newId.longValue());
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

	private val insertActor = SimpleJdbcInsert(dataSource)
			.withTableName("t_actor")
			.usingColumns("first_name", "last_name")
			.usingGeneratedKeyColumns("id")

	fun add(actor: Actor): Actor {
		val parameters = mapOf(
				"first_name" to actor.firstName,
				"last_name" to actor.lastName)
		val newId = insertActor.executeAndReturnKey(parameters);
		return actor.copy(id = newId.toLong())
	}

	// ... additional methods
}

插入的执行与依赖元数据来确定要使用的列时相同。

使用 SqlParameterSource 提供参数值

使用 Map 提供参数值很好，但它不是最方便使用的类。Spring 提供了 SqlParameterSource 接口的几种实现，您可以选择使用它们。第一个是 BeanPropertySqlParameterSource，如果您有一个包含值的符合 JavaBean 规范的类，这是一个非常方便的类。它使用相应的 getter 方法来提取参数值。以下示例展示了如何使用 BeanPropertySqlParameterSource

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcInsert insertActor;

	public void setDataSource(DataSource dataSource) {
		this.insertActor = new SimpleJdbcInsert(dataSource)
				.withTableName("t_actor")
				.usingGeneratedKeyColumns("id");
	}

	public void add(Actor actor) {
		SqlParameterSource parameters = new BeanPropertySqlParameterSource(actor);
		Number newId = insertActor.executeAndReturnKey(parameters);
		actor.setId(newId.longValue());
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

	private val insertActor = SimpleJdbcInsert(dataSource)
			.withTableName("t_actor")
			.usingGeneratedKeyColumns("id")

	fun add(actor: Actor): Actor {
		val parameters = BeanPropertySqlParameterSource(actor)
		val newId = insertActor.executeAndReturnKey(parameters)
		return actor.copy(id = newId.toLong())
	}

	// ... additional methods
}

另一种选择是 MapSqlParameterSource，它类似于 Map，但提供了一个更方便的 addValue 方法，可以进行链式调用。以下示例展示了如何使用它

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcInsert insertActor;

	public void setDataSource(DataSource dataSource) {
		this.insertActor = new SimpleJdbcInsert(dataSource)
				.withTableName("t_actor")
				.usingGeneratedKeyColumns("id");
	}

	public void add(Actor actor) {
		SqlParameterSource parameters = new MapSqlParameterSource()
				.addValue("first_name", actor.getFirstName())
				.addValue("last_name", actor.getLastName());
		Number newId = insertActor.executeAndReturnKey(parameters);
		actor.setId(newId.longValue());
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

	private val insertActor = SimpleJdbcInsert(dataSource)
			.withTableName("t_actor")
			.usingGeneratedKeyColumns("id")

	fun add(actor: Actor): Actor {
		val parameters = MapSqlParameterSource()
					.addValue("first_name", actor.firstName)
					.addValue("last_name", actor.lastName)
		val newId = insertActor.executeAndReturnKey(parameters)
		return actor.copy(id = newId.toLong())
	}

	// ... additional methods
}

如您所见，配置是相同的。只需要更改执行代码即可使用这些替代的输入类。

使用 SimpleJdbcCall 调用存储过程

SimpleJdbcCall 类使用数据库中的元数据查找 in 和 out 参数的名称，这样您就不必显式声明它们。如果您愿意，或者如果您的参数没有自动映射到 Java 类，您可以声明参数。第一个示例展示了一个简单的过程，该过程仅从 MySQL 数据库返回 VARCHAR 和 DATE 格式的标量值。该示例过程读取指定的演员条目，并以 out 参数的形式返回 first_name、last_name 和 birth_date 列。以下列表展示了第一个示例

CREATE PROCEDURE read_actor (
	IN in_id INTEGER,
	OUT out_first_name VARCHAR(100),
	OUT out_last_name VARCHAR(100),
	OUT out_birth_date DATE)
BEGIN
	SELECT first_name, last_name, birth_date
	INTO out_first_name, out_last_name, out_birth_date
	FROM t_actor where id = in_id;
END;

in_id 参数包含您正在查找的演员的 id。out 参数返回从表中读取的数据。

您可以以类似于声明 SimpleJdbcInsert 的方式声明 SimpleJdbcCall。您应该在数据访问层的初始化方法中实例化和配置该类。与 StoredProcedure 类相比，您不需要创建子类，也不需要声明可以在数据库元数据中查找的参数。以下是一个 SimpleJdbcCall 配置示例，它使用了上述存储过程（除了 DataSource 之外，唯一的配置选项是存储过程的名称）

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcCall procReadActor;

	public void setDataSource(DataSource dataSource) {
		this.procReadActor = new SimpleJdbcCall(dataSource)
				.withProcedureName("read_actor");
	}

	public Actor readActor(Long id) {
		SqlParameterSource in = new MapSqlParameterSource()
				.addValue("in_id", id);
		Map out = procReadActor.execute(in);
		Actor actor = new Actor();
		actor.setId(id);
		actor.setFirstName((String) out.get("out_first_name"));
		actor.setLastName((String) out.get("out_last_name"));
		actor.setBirthDate((Date) out.get("out_birth_date"));
		return actor;
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

	private val procReadActor = SimpleJdbcCall(dataSource)
			.withProcedureName("read_actor")


	fun readActor(id: Long): Actor {
		val source = MapSqlParameterSource().addValue("in_id", id)
		val output = procReadActor.execute(source)
		return Actor(
				id,
				output["out_first_name"] as String,
				output["out_last_name"] as String,
				output["out_birth_date"] as Date)
	}

		// ... additional methods
}

您为执行调用编写的代码涉及创建一个包含 IN 参数的 SqlParameterSource。您提供的输入值的名称必须与存储过程中声明的参数名称匹配。大小写不必匹配，因为您使用元数据来确定在存储过程中如何引用数据库对象。存储过程源代码中指定的内容不一定与数据库中的存储方式相同。一些数据库会将名称转换为全大写，而另一些则使用小写或使用指定的原始大小写。

execute 方法接受 IN 参数并返回一个 Map，该 Map 包含以存储过程中指定的名称为键的任何 out 参数。在本例中，它们是 out_first_name、out_last_name 和 out_birth_date。

execute 方法的最后一部分创建了一个 Actor 实例，用于返回检索到的数据。同样重要的是使用存储过程中声明的 out 参数名称。此外，结果 Map 中存储的 out 参数名称的大小写与数据库中 out 参数名称的大小写匹配，这可能因数据库而异。为了使您的代码更具可移植性，您应该执行不区分大小写的查找，或者指示 Spring 使用 LinkedCaseInsensitiveMap。要实现后者，您可以创建自己的 JdbcTemplate 并将 setResultsMapCaseInsensitive 属性设置为 true。然后，您可以将此定制的 JdbcTemplate 实例传递给 SimpleJdbcCall 的构造函数。以下示例显示了此配置

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcCall procReadActor;

	public void setDataSource(DataSource dataSource) {
		JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
		jdbcTemplate.setResultsMapCaseInsensitive(true);
		this.procReadActor = new SimpleJdbcCall(jdbcTemplate)
				.withProcedureName("read_actor");
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

	private var procReadActor = SimpleJdbcCall(JdbcTemplate(dataSource).apply {
		isResultsMapCaseInsensitive = true
	}).withProcedureName("read_actor")

	// ... additional methods
}

通过执行此操作，您可以避免返回的 out 参数名称在使用大小写方面出现冲突。

显式声明用于 SimpleJdbcCall 的参数

在本章前面，我们描述了如何从元数据中推断参数，但如果需要，您可以显式声明它们。您可以通过使用 declareParameters 方法创建和配置 SimpleJdbcCall 来实现，该方法接受可变数量的 SqlParameter 对象作为输入。有关如何定义 SqlParameter 的详细信息，请参阅下一节。

如果您使用的数据库不是 Spring 支持的数据库，则需要显式声明。目前，Spring 支持对以下数据库进行存储过程调用的元数据查找：Apache Derby、DB2、MySQL、Microsoft SQL Server、Oracle 和 Sybase。我们还支持对 MySQL、Microsoft SQL Server 和 Oracle 进行存储函数调用的元数据查找。

您可以选择显式声明部分或所有参数。在您未显式声明参数的地方，仍会使用参数元数据。要绕过对潜在参数的所有元数据查找处理，并仅使用声明的参数，您可以在声明中调用 withoutProcedureColumnMetaDataAccess 方法。假设您为数据库函数声明了两个或更多不同的调用签名。在这种情况下，您调用 useInParameterNames 来指定给定签名的 IN 参数名称列表。

以下示例显示了一个完全声明的过程调用，并使用了上一个示例中的信息

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcCall procReadActor;

	public void setDataSource(DataSource dataSource) {
		JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
		jdbcTemplate.setResultsMapCaseInsensitive(true);
		this.procReadActor = new SimpleJdbcCall(jdbcTemplate)
				.withProcedureName("read_actor")
				.withoutProcedureColumnMetaDataAccess()
				.useInParameterNames("in_id")
				.declareParameters(
						new SqlParameter("in_id", Types.NUMERIC),
						new SqlOutParameter("out_first_name", Types.VARCHAR),
						new SqlOutParameter("out_last_name", Types.VARCHAR),
						new SqlOutParameter("out_birth_date", Types.DATE)
				);
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

		private val procReadActor = SimpleJdbcCall(JdbcTemplate(dataSource).apply {
			isResultsMapCaseInsensitive = true
		}).withProcedureName("read_actor")
				.withoutProcedureColumnMetaDataAccess()
				.useInParameterNames("in_id")
				.declareParameters(
						SqlParameter("in_id", Types.NUMERIC),
						SqlOutParameter("out_first_name", Types.VARCHAR),
						SqlOutParameter("out_last_name", Types.VARCHAR),
						SqlOutParameter("out_birth_date", Types.DATE)
	)

		// ... additional methods
}

这两个示例的执行和最终结果是相同的。第二个示例显式指定了所有详细信息，而不是依赖元数据。

如何定义 SqlParameters

要为 SimpleJdbc 类以及 RDBMS 操作类（在将 JDBC 操作建模为 Java 对象中介绍）定义参数，您可以使用 SqlParameter 或其子类之一。通常，您在构造函数中指定参数名称和 SQL 类型。SQL 类型使用 java.sql.Types 常量指定。在本章前面，我们看到了类似于以下的声明

  • Java

  • Kotlin

new SqlParameter("in_id", Types.NUMERIC),
new SqlOutParameter("out_first_name", Types.VARCHAR),
SqlParameter("in_id", Types.NUMERIC),
SqlOutParameter("out_first_name", Types.VARCHAR),

第一行中的 SqlParameter 声明了一个 IN 参数。您可以使用 SqlQuery 及其子类（在理解 SqlQuery中介绍）将 IN 参数用于存储过程调用和查询。

第二行（包含 SqlOutParameter）声明了一个用于存储过程调用的 out 参数。还有一个 SqlInOutParameter 用于 InOut 参数（向过程提供 IN 值并且也返回值的参数）。

只有声明为 SqlParameter 和 SqlInOutParameter 的参数才用于提供输入值。这与 StoredProcedure 类不同，后者（出于向后兼容的原因）允许为声明为 SqlOutParameter 的参数提供输入值。

对于 IN 参数，除了名称和 SQL 类型之外，您还可以指定数字数据的 scale 或自定义数据库类型的类型名称。对于 out 参数，您可以提供一个 RowMapper 来处理从 REF cursor 返回的行的映射。另一种选择是指定一个 SqlReturnType，它提供了一个定义返回值的自定义处理的机会。

使用 SimpleJdbcCall 调用存储函数

调用存储函数的方式与调用存储过程的方式几乎相同，只是您提供的是函数名称而不是过程名称。您使用 withFunctionName 方法作为配置的一部分，以表明您要调用一个函数，并生成相应的函数调用字符串。一个专门的调用（executeFunction）用于运行函数，并以指定类型的对象形式返回函数返回值，这意味着您不必从结果 Map 中检索返回值。对于只有一个 out 参数的存储过程，还有一个类似的便捷方法（名为 executeObject）。以下示例（针对 MySQL）基于名为 get_actor_name 的存储函数，该函数返回演员的全名

CREATE FUNCTION get_actor_name (in_id INTEGER)
RETURNS VARCHAR(200) READS SQL DATA
BEGIN
	DECLARE out_name VARCHAR(200);
	SELECT concat(first_name, ' ', last_name)
		INTO out_name
		FROM t_actor where id = in_id;
	RETURN out_name;
END;

为了调用此函数，我们再次在初始化方法中创建一个 SimpleJdbcCall，如下例所示

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcCall funcGetActorName;

	public void setDataSource(DataSource dataSource) {
		JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
		jdbcTemplate.setResultsMapCaseInsensitive(true);
		this.funcGetActorName = new SimpleJdbcCall(jdbcTemplate)
				.withFunctionName("get_actor_name");
	}

	public String getActorName(Long id) {
		SqlParameterSource in = new MapSqlParameterSource()
				.addValue("in_id", id);
		String name = funcGetActorName.executeFunction(String.class, in);
		return name;
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

	private val jdbcTemplate = JdbcTemplate(dataSource).apply {
		isResultsMapCaseInsensitive = true
	}
	private val funcGetActorName = SimpleJdbcCall(jdbcTemplate)
			.withFunctionName("get_actor_name")

	fun getActorName(id: Long): String {
		val source = MapSqlParameterSource().addValue("in_id", id)
		return funcGetActorName.executeFunction(String::class.java, source)
	}

	// ... additional methods
}

使用的 executeFunction 方法返回一个包含函数调用返回值的 String。

从 SimpleJdbcCall 返回 ResultSet 或 REF Cursor

调用返回结果集的存储过程或函数有点棘手。有些数据库在 JDBC 结果处理期间返回结果集，而另一些数据库则需要显式注册特定类型的 out 参数。这两种方法都需要额外的处理来循环遍历结果集并处理返回的行。使用 SimpleJdbcCall，您可以使用 returningResultSet 方法并声明一个 RowMapper 实现用于特定的参数。如果在结果处理期间返回结果集，则没有定义名称，因此返回的结果必须与您声明 RowMapper 实现的顺序匹配。指定的名称仍用于将处理过的结果列表存储在从 execute 语句返回的结果 Map 中。

下一个示例（针对 MySQL）使用了一个存储过程，该过程不接受 IN 参数并返回 t_actor 表中的所有行

CREATE PROCEDURE read_all_actors()
BEGIN
 SELECT a.id, a.first_name, a.last_name, a.birth_date FROM t_actor a;
END;

要调用此过程，您可以声明 RowMapper。由于您希望映射到的类遵循 JavaBean 规则，因此您可以使用通过在 newInstance 方法中传入所需的类来创建的 BeanPropertyRowMapper。以下示例展示了如何进行操作

  • Java

  • Kotlin

public class JdbcActorDao implements ActorDao {

	private SimpleJdbcCall procReadAllActors;

	public void setDataSource(DataSource dataSource) {
		JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
		jdbcTemplate.setResultsMapCaseInsensitive(true);
		this.procReadAllActors = new SimpleJdbcCall(jdbcTemplate)
				.withProcedureName("read_all_actors")
				.returningResultSet("actors",
				BeanPropertyRowMapper.newInstance(Actor.class));
	}

	public List getActorsList() {
		Map m = procReadAllActors.execute(new HashMap<String, Object>(0));
		return (List) m.get("actors");
	}

	// ... additional methods
}
class JdbcActorDao(dataSource: DataSource) : ActorDao {

		private val procReadAllActors = SimpleJdbcCall(JdbcTemplate(dataSource).apply {
			isResultsMapCaseInsensitive = true
		}).withProcedureName("read_all_actors")
				.returningResultSet("actors",
						BeanPropertyRowMapper.newInstance(Actor::class.java))

	fun getActorsList(): List<Actor> {
		val m = procReadAllActors.execute(mapOf<String, Any>())
		return m["actors"] as List<Actor>
	}

	// ... additional methods
}

execute 调用传入了一个空的 Map，因为此调用不接受任何参数。然后从结果 Map 中检索演员列表并返回给调用者。