、のKeyGenerator概要
通常の開発、多くの場合、このような要望を持っているメインキーに戻ってデータを挿入する、またはデータがこの需要MyBatisの前に主キーを取得する必要が挿入もサポートされている場合、するKeyGeneratorのメインロジック部は、次のように彼のクラス特徴であります図:
どこで:
- NoKeyGenerator:空の実装をデフォルトの、主キーは個別に処理する必要はありません。
- Jdbc3KeyGenerator:などのMySQL、PostgreSQLのようプライマリ・データベースの自動インクリメントの主キー、;
- SelectKeyGenerator:データベースは、オラクル、DB2等の場合増分主キーをサポートしていないために主に使用されます。
インタフェースは次のとおりです。
public interface KeyGenerator {
void processBefore(Executor executor, MappedStatement ms, Statement stmt, Object parameter);
void processAfter(Executor executor, MappedStatement ms, Statement stmt, Object parameter);
}
見られるようにするKeyGeneratorコードは、主に二つの方法を傍受することによって非常に簡単に達成されます。
- Jdbc3KeyGenerator:java.sql.Statement.getGeneratedKeysは主に戻すために、プライマリインターフェイスに基づいて、彼はprocessBefore方法を必要としない、唯一の結果を得た後processAfterノックダウンを使用する必要があり、その後に設定することができる主キーパラメータに反映。
- SelectKeyGenerator:主にXML構成またはアノテーションを介しが提供selectKeyは、その後に、のみ傍受するために2つの方法のいずれかを使用することができ、戻り反射傍受法に設けられたプライマリ・キーを使用して、単一のクエリを発行selectKey.order属性セット
AFTER|BEFORE
決定します。
インターセプトタイミング:
processBeforeはStatementHandler時に生成されます。
protected BaseStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
...
if (boundSql == null) { // issue #435, get the key before calculating the statement
generateKeys(parameterObject);
boundSql = mappedStatement.getBoundSql(parameterObject);
}
...
}
protected void generateKeys(Object parameter) {
KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();
ErrorContext.instance().store();
keyGenerator.processBefore(executor, mappedStatement, null, parameter);
ErrorContext.instance().recall();
}
processAfterはPreparedStatementHandler、SimpleStatementHandler、少し異なるCallableStatementHandlerコードを返される結果を完了する前に挿入されているが、位置が変化しない、PreparedStatementHandler本明細書の実施例の方法による。
@Override
public int update(Statement statement) throws SQLException {
PreparedStatement ps = (PreparedStatement) statement;
ps.execute();
int rows = ps.getUpdateCount();
Object parameterObject = boundSql.getParameterObject();
KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();
keyGenerator.processAfter(executor, mappedStatement, ps, parameterObject);
return rows;
}
二、Jdbc3KeyGenerator
わずかに異なるPreparedStatementHandler、更新方法SimpleStatementHandlerその結果、上記主界面に返さJdbc3KeyGenerator java.sql.Statement.getGeneratedKeys主キー、およびPreparedStatementのステートメントに基づいて説明するが、わずかに異なります。
// java.sql.Connection
PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException;
PreparedStatement prepareStatement(String sql, String columnNames[]) throws SQLException;
PreparedStatement prepareStatement(String sql, int columnIndexes[]) throws SQLException;
// java.sql.Statement
boolean execute(String sql, int autoGeneratedKeys) throws SQLException;
boolean execute(String sql, int columnIndexes[]) throws SQLException;
boolean execute(String sql, String columnNames[]) throws SQLException;
// 其中 autoGenerateKeys - Statement.RETURN_GENERATED_KEYS、Statement.NO_GENERATED_KEYS
PreparedStatementのは見ることができ、彼が指定時にインスタンス化され、そして声明だけのPreparedStatement例にここでは、SQLの実装で指定されたが、本質は同じです。
public void testJDBC3() {
try {
String url = "jdbc:mysql://localhost:3306/mybatis?serverTimezone=GMT";
String sql = "INSERT INTO user(username,password,address) VALUES (?,?,?)";
Class.forName("com.mysql.jdbc.Driver");
Connection conn = DriverManager.getConnection(url, "root", "root");
String[] columnNames = {"ids", "name"};
PreparedStatement stmt = conn.prepareStatement(sql, columnNames);
stmt.setString(1, "test");
stmt.setString(2, "123456");
stmt.setString(3, "test");
stmt.executeUpdate();
ResultSet rs = stmt.getGeneratedKeys();
int id = 0;
if (rs.next()) {
id = rs.getInt(1);
System.out.println("----------" + id);
}
} catch (Exception e) {
e.printStackTrace();
}
}
ここでは、ID主キーへのユーザーテーブルがありますが、コードは、私は満たされていないCOLUMNNAMESを通過し、その結果が正しいリターン主な理由は、長いドライブの主キーは、columnNames.length> 1をすることができMyBatisのことができ、特定のでそうまた持ち込ま異なるデータベースドライバの異なる効果を達成するために使用する場合ことに注意してください。
上記のメインのPreparedStatementに戻っての声明では、我々は明確に以下を参照してくださいすることができ、別のキー位置を指定します。
// org.apache.ibatis.executor.statement.SimpleStatementHandler
public int update(Statement statement) throws SQLException {
String sql = boundSql.getSql();
Object parameterObject = boundSql.getParameterObject();
KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();
int rows;
if (keyGenerator instanceof Jdbc3KeyGenerator) {
statement.execute(sql, Statement.RETURN_GENERATED_KEYS);
rows = statement.getUpdateCount();
keyGenerator.processAfter(executor, mappedStatement, statement, parameterObject);
} else if (keyGenerator instanceof SelectKeyGenerator) {
statement.execute(sql);
rows = statement.getUpdateCount();
keyGenerator.processAfter(executor, mappedStatement, statement, parameterObject);
} else {
//如果没有keyGenerator,直接调用Statement.execute和Statement.getUpdateCount
statement.execute(sql);
rows = statement.getUpdateCount();
}
return rows;
}
// org.apache.ibatis.executor.statement.PreparedStatementHandler
protected Statement instantiateStatement(Connection connection) throws SQLException {
String sql = boundSql.getSql();
if (mappedStatement.getKeyGenerator() instanceof Jdbc3KeyGenerator) {
String[] keyColumnNames = mappedStatement.getKeyColumns();
if (keyColumnNames == null) {
return connection.prepareStatement(sql, PreparedStatement.RETURN_GENERATED_KEYS);
} else {
return connection.prepareStatement(sql, keyColumnNames);
}
} else if (mappedStatement.getResultSetType() != null) {
return connection.prepareStatement(sql, mappedStatement.getResultSetType().getValue(), ResultSet.CONCUR_READ_ONLY);
} else {
return connection.prepareStatement(sql);
}
}
初期化が完了すると、のJdbc3KeyGenerator最も重要なインターセプト方法を見てみましょう:
public void processAfter(Executor executor, MappedStatement ms, Statement stmt, Object parameter) {
List<Object> parameters = new ArrayList<Object>();
parameters.add(parameter);
processBatch(ms, stmt, parameters);
}
public void processBatch(MappedStatement ms, Statement stmt, List<Object> parameters) {
ResultSet rs = null;
try {
//核心是使用JDBC3的Statement.getGeneratedKeys
rs = stmt.getGeneratedKeys();
final Configuration configuration = ms.getConfiguration();
final TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
final String[] keyProperties = ms.getKeyProperties();
final ResultSetMetaData rsmd = rs.getMetaData();
TypeHandler<?>[] typeHandlers = null;
if (keyProperties != null && rsmd.getColumnCount() >= keyProperties.length) {
for (Object parameter : parameters) {
// there should be one row for each statement (also one for each parameter)
if (!rs.next()) {
break;
}
final MetaObject metaParam = configuration.newMetaObject(parameter);
if (typeHandlers == null) {
//先取得类型处理器
typeHandlers = getTypeHandlers(typeHandlerRegistry, metaParam, keyProperties);
}
//填充键值
populateKeys(rs, metaParam, keyProperties, typeHandlers);
}
}
} catch (Exception e) {
...
}
}
ここでは、主キーへの明確な、直接のアクセスを返し、その後、パラメータを使用して反射時間に提供されます。
三、SelectKeyGenerator
上記にもSelectKeyGeneratorは、主にselectKey使用processBeforeのデフォルトを設定するために使用されますが、するように構成することができ話し注文プロパティを(AFTER |前の);
<insert id="insertUser2" parameterType="u" useGeneratedKeys="true" keyProperty="id">
<selectKey keyProperty="id" resultType="long" order="BEFORE">
SELECT if(max(id) is null,1,max(id)+2) as newId FROM user2
</selectKey>
INSERT INTO user2(id,username,password,address) VALUES (#{id},#{userName},#{password},#{address})
</insert>
ここでは、ソースコードを直接見:
public void processBefore(Executor executor, MappedStatement ms, Statement stmt, Object parameter) {
if (executeBefore) processGeneratedKeys(executor, ms, parameter);
}
public void processAfter(Executor executor, MappedStatement ms, Statement stmt, Object parameter) {
if (!executeBefore) processGeneratedKeys(executor, ms, parameter);
}
private void processGeneratedKeys(Executor executor, MappedStatement ms, Object parameter) {
try {
if (parameter != null && keyStatement != null && keyStatement.getKeyProperties() != null) {
String[] keyProperties = keyStatement.getKeyProperties();
final Configuration configuration = ms.getConfiguration();
final MetaObject metaParam = configuration.newMetaObject(parameter);
if (keyProperties != null) {
// Do not close keyExecutor.
// The transaction will be closed by parent executor.
Executor keyExecutor = configuration.newExecutor(executor.getTransaction(), ExecutorType.SIMPLE);
List<Object> values = keyExecutor.query(keyStatement, parameter, RowBounds.DEFAULT, Executor.NO_RESULT_HANDLER);
if (values.size() == 0) {
throw new ExecutorException("SelectKey returned no data.");
} else if (values.size() > 1) {
throw new ExecutorException("SelectKey returned more than one value.");
} else {
MetaObject metaResult = configuration.newMetaObject(values.get(0));
if (keyProperties.length == 1) {
if (metaResult.hasGetter(keyProperties[0])) {
setValue(metaParam, keyProperties[0], metaResult.getValue(keyProperties[0]));
} else {
// no getter for the property - maybe just a single value object
// so try that
setValue(metaParam, keyProperties[0], values.get(0));
}
} else {
handleMultipleProperties(keyProperties, metaParam, metaResult);
}
}
}
}
} catch (ExecutorException e) {
...
}
}
その後、パラメータセットに反映されているこのコードは、新しい再発ExecutorのSQLを使用することで、また非常に簡単です。