对于最新的稳定版本，请使用 Spring Framework 7.0.6!spring-doc.cadn.net.cn

通过SimpleJdbc类简化JDBC操作

SimpleJdbcInsert 和 SimpleJdbcCall 类通过利用可以通过 JDBC 驱动程序检索的数据库元数据，提供了简化的配置。 这意味着您一开始需要配置的内容更少，尽管如果您希望在代码中提供所有细节，可以覆盖或关闭元数据处理。spring-doc.cadn.net.cn

使用SimpleJdbcInsert插入数据

我们首先查看具有最少配置选项的 SimpleJdbcInsert 类。您应该在数据访问层的初始化方法中实例化 SimpleJdbcInsert。对于此示例，初始化方法是 setDataSource 方法。您不需要继承 SimpleJdbcInsert 类。相反，您可以创建一个新实例并通过使用 withTableName 方法设置表名。此类的配置方法遵循返回 SimpleJdbcInsert 实例的 fluid 风格，这使您可以链接所有配置方法。下面的示例仅使用了一个配置方法（我们稍后会展示多个方法的示例）：spring-doc.cadn.net.cn

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 的键必须与数据库中定义的表的列名匹配。这是因为我们读取元数据来构造实际的插入语句。spring-doc.cadn.net.cn

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

下一个示例使用与前一个示例相同的插入操作，但不是传入id，而是检索自动生成的键并将其设置在新的Actor对象上。当它创建SimpleJdbcInsert时，除了指定表名外，还通过usingGeneratedKeyColumns方法指定了生成的键列的名称。下面的列表显示了其工作方式：spring-doc.cadn.net.cn

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。spring-doc.cadn.net.cn

为一个SimpleJdbcInsert指定列

您可以使用usingColumns方法通过指定列名列表来限制插入的列，如下例所示：spring-doc.cadn.net.cn

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
}

插入的执行方式与你依赖元数据来确定使用哪些列的方式相同。spring-doc.cadn.net.cn

使用 SqlParameterSource 提供参数值

使用 Map 来提供参数值可以正常工作，但并不是最方便的类。Spring 提供了 SqlParameterSource 接口的一些实现类，您可以改用这些类。第一个是 BeanPropertySqlParameterSource，如果您有一个符合 JavaBean 规范的类来存储您的值，这个类非常方便。它使用相应的 getter 方法来提取参数值。下面的示例展示了如何使用 BeanPropertySqlParameterSource：spring-doc.cadn.net.cn

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方法，可以进行链式调用。下面的例子展示了如何使用它：spring-doc.cadn.net.cn

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
}

正如你所看到的，配置是相同的。只有执行的代码需要更改以使用这些替代输入类。spring-doc.cadn.net.cn

调用存储过程通过 SimpleJdbcCall

SimpleJdbcCall 类使用数据库中的元数据来查找 in 和 out 参数的名称，这样您就不必显式声明它们。如果您更喜欢这样做，或者如果您有参数（例如 ARRAY 或 STRUCT）无法自动映射到 Java 类，您可以声明参数。第一个示例显示了一个从 MySQL 数据库中仅以 VARCHAR 和 DATE 格式返回标量值的简单存储过程。该示例存储过程读取指定的演员条目，并以 out 参数的形式返回 first_name、last_name 和 birth_date 列。 以下列表显示了第一个示例：spring-doc.cadn.net.cn

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 参数返回从表中读取的数据。spring-doc.cadn.net.cn

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

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。您必须将提供的输入值名称与存储过程声明的参数名称匹配。大小写不需要匹配，因为您使用元数据来确定数据库对象在存储过程中应如何引用。存储过程源中指定的内容不一定是它在数据库中的存储方式。某些数据库会将名称转换为全大写，而其他数据库则使用小写或使用指定的大小写。spring-doc.cadn.net.cn

execute 方法接受 IN 参数，并返回一个包含任何 Map 的 out，该参数通过名称进行键控，如存储过程所指定的。在这种情况下，它们是 out_first_name、out_last_name 和 out_birth_date。spring-doc.cadn.net.cn

execute 方法的最后部分创建了一个 Actor 实例，用于返回检索到的数据。同样，使用存储过程中的 out 参数名称非常重要。此外，结果映射中存储的 out 参数名称的大小写与数据库中的 out 参数名称的大小写匹配，这在不同数据库之间可能会有所不同。为了使您的代码更具可移植性，您应该进行不区分大小写的查找，或者指示 Spring 使用 LinkedCaseInsensitiveMap。要实现后者，您可以创建自己的 JdbcTemplate 并将 setResultsMapCaseInsensitive 属性设置为 true。然后可以将此自定义的 JdbcTemplate 实例传递给您的 SimpleJdbcCall 的构造函数。下面的示例显示了此配置：spring-doc.cadn.net.cn

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参数名称时出现冲突。spring-doc.cadn.net.cn

显式声明要用于 SimpleJdbcCall 的参数

在本章前面，我们描述了如何从元数据中推断参数，但如果您希望，可以显式声明它们。您可以通过创建并配置SimpleJdbcCall，并使用declareParameters方法，该方法接受可变数量的SqlParameter对象作为输入。有关如何定义SqlParameter的详细信息，请参阅< a t="C4">下一节。spring-doc.cadn.net.cn

显式声明在你使用的数据库不是Spring支持的数据库时是必要的。目前，Spring支持以下数据库的存储过程调用元数据查找：Apache Derby、DB2、MySQL、Microsoft SQL Server、Oracle和Sybase。我们还支持MySQL、Microsoft SQL Server和Oracle的存储函数元数据查找。

您可以选择显式声明一个、一些或所有参数。在您没有显式声明参数的地方，仍会使用参数元数据。要绕过对潜在参数的元数据查找处理，并仅使用已声明的参数，可以在声明过程中调用方法 withoutProcedureColumnMetaDataAccess。假设您为数据库函数声明了两个或多个不同的调用签名。在这种情况下，您调用 useInParameterNames 来指定给定签名中要包含的 IN 参数名称列表。spring-doc.cadn.net.cn

以下示例显示了一个完全声明的存储过程调用，并使用了前面示例中的信息：spring-doc.cadn.net.cn

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
}

这两个示例的执行和最终结果是相同的。第二个示例明确指定了所有细节，而不是依赖元数据。spring-doc.cadn.net.cn

如何定义 SqlParameters 值

要为 SimpleJdbc 类和 RDBMS 操作类（在 将 JDBC 操作建模为 Java 对象 中介绍）定义参数，可以使用 SqlParameter 或其某个子类。 要做到这一点，通常需要在构造函数中指定参数名称和 SQL 类型。SQL 类型通过使用 java.sql.Types 常量来指定。在本章之前，我们看到过类似以下的声明：spring-doc.cadn.net.cn

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 参数。您可以使用 IN 参数来调用存储过程和查询，方法是使用 SqlQuery 及其子类（在 了解 SqlQuery 中有介绍）。spring-doc.cadn.net.cn

第二行（带有SqlOutParameter）声明了一个out参数，用于存储过程调用。还有一个SqlInOutParameter用于InOut参数（为过程提供IN值并返回值的参数）。spring-doc.cadn.net.cn

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

对于 IN 参数，除了名称和 SQL 类型外，还可以为数值数据指定一个精度，或为自定义数据库类型指定一个类型名称。对于 out 参数，您可以提供一个 RowMapper 来处理从 REF 光标返回的行映射。另一个选项是指定一个 SqlReturnType，这提供了定义返回值自定义处理方式的机会。spring-doc.cadn.net.cn

使用SimpleJdbcCall调用存储函数

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

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， 如下例所示：spring-doc.cadn.net.cn

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，其中包含函数调用的返回值。spring-doc.cadn.net.cn

从 SimpleJdbcCall 返回 ResultSet 或 REF 游标

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

下一个示例（针对MySQL）使用了一个不带IN参数的存储过程，并从t_actor表中返回所有行：spring-doc.cadn.net.cn

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。 以下示例显示了如何操作：spring-doc.cadn.net.cn

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，因为此调用不接受任何参数。 然后从结果映射中检索演员列表并返回给调用者。spring-doc.cadn.net.cn