SQL映射文件 · Java 開源項目中文文檔

# SQL映射文件 MyBatis Generator (MBG)生成SQL映射文件遵循MyBatis或iBATIS SQL Map DTD規范. 在表的基礎上這些文件還包含了不同的標簽和屬性配置. MBG按照配置表生成SQL映射文件.表名就是SQL映射文件的命名空間(前提是數據庫支持schema和catalog,主流數據庫對schema和catalog都支持).MBG不會自動把 SQL映射文件到MyBatis/iBATIS配置文件中 - 您必須手動把`xxxMapper.xml`文件加入到配置文件中(或者您使用一個插件使MBG生成配置文件;Spring配置文件可以實現自動掃描`xxxMapper.xml`和接口). 每個自動生成的XML方法標簽下都包含`@mbggenerated`的注釋塊.在運行的時候`@mbggenerated`注釋塊將刪除和替換.其他部分內容將保持不變. 考慮到這點,不用擔心在運行時丟失您新增內容--不包括`@mbggenerated`塊內容. 以下部分描述了將要生成的元素. 注意:下面描述中"BLOB"指任何列的BLOB數據類型包括BLOB, CLOB, LONGVARCHAR, 和 LONGVARBINARY. ## 結果集結果集用于數據庫表列映射Java對象的屬性. 結果集(和相應的查詢語句)不包括如下情況: * 任何列配置`<ignoreColumn>`屬性將被會被忽略 * 任何BLOB字段(詳見有關BLOBs字段相關映射) 對于列配置`<columnOverride>`屬性將映射成配置的名稱.沒有配置使用的是默認的屬性和JDBC類型. 對于自定義連接查詢結果集繼承一個結果集是一種非常常見的用法. 對于其他連接查詢也想使用該結果集在MBG自動生成的時候需要配置前綴.詳見[<table>](../configreference/table.html)屬性alias配置前綴,這樣做法可以區分表中相同字段. 如果table配置enableSelectByExample、enableSelectByPrimaryKey屬性為true,MBG會生成結果集,table默認這兩個配置都是true,所以大部分情況下都會生成resultMap. ## BLOB結果集表中存在BLOB字段時MBG會自動生成一個BLOB結果集,BLOB結果集繼承了除BLOB字段外的基礎結果集. 我們提供不同的版本查詢語句,來適應查詢結果中是否需要BLOB字段. BLOB結果集(和相應的查詢語句)不包括如下情況: * 任何列配置`<ignoreColumn>`屬性將被會被忽略對于列配置`<columnOverride>`屬性將映射成配置的名稱.沒有配置使用的是默認的屬性和JDBC類型. 對于自定義連接查詢結果集繼承一個結果集是一種非常常見的用法.對于其他連接查詢也想使用該結果集,在MBG自動生成的時候需要配置前綴.詳見[<table>](../configreference/table.html) 性alias配置前綴,這樣做法可以區分表中相同字段. 如果table存在BLOB字段且配置了enableSelectByExample、enableSelectByPrimaryKey屬性,MBG會生成BLOB結果集,table默認這兩個配置都是true所以大部分情況下都會生成resultMap. ## Where條件SQL語句 "by example"方法重用Where條件.被重用的Where條件不包括BLOB字段.大部分表WHERE條件都不支持BLOB字段. "by example"語句被配置將動態生成Where條件語句. ## 根據主鍵查詢 select語句按照主鍵查詢返回一行數據.如果表中存在BLOB字段,查詢結果中會包含該字段. 如果table配置了enableSelectByExample、enableSelectByPrimaryKey屬性為true,MBG會生成結果集,table默認這兩個配置都是true所以大部分情況下都會生成resultMap. ## 根據條件查詢根據條件查詢結果集和自動生成對象相匹配. 通過實現一個簡單的"query by example"方法可以適用于不同的數據庫查詢.就算表中存在BLOB字段該查詢結果集也不會返回該BLOB字段 (具體返回BLOB字段詳見根據條件查詢包含BLOB字段結果集部分描述). **重要:**條件為空或者沒有設置條件時,會將表中**所有**數據查詢出來. 如果table配置了enableSelectByExample屬性為true,MBG會生成Example查詢. ## 根據條件查詢包含BLOB字段(方法:selectByExampleWithBLOBs) Example查詢結果集和自動生成對象相匹配. 通過實現一個簡單的"query by example"方法可以適用于不同的數據庫查詢.算表中存在BLOB字段該查詢結果集將返回該BLOB字段. **重要:** 查詢條件為空或者沒有設置查詢條件時,會將表中**所有**數據查詢出來. 如果table配置了enableSelectByExample屬性為true,MBG會生成包含BLOB字段的Example查詢. ## 插入該方法可以插入表中所有字段(包括BLOB字段),但列配置了`<ignoreColumn>`屬性將不會插入. 如果表有主鍵自動增長(自動增長列或序列),table子元素配置`<generatedKey>`屬性,MBG會生成`<selectKey>`塊語句,一般情況下都不需要配置使用數據庫自動增長即可,除非表字段需要使用序列. **重要提示:**與iBATIS2和MyBatis3插入的差異.差異如下: | 運行 | 特性 | | --- | --- | | iBATIS2 | 配置了<generatedKey>屬性,插入的時候會返回新的自動增長值.沒有配置<generatedKey>屬性, 插入返回值為`void`. | | MyBatis3 | 插入方法將返回插入受影響的行數(通常是0或者1). 配置了<generatedKey>屬性,自動增長值會被設置在參數對象中返回. | 如果table配置了enableInsert屬性為true,MBG會生成該方法. ## 選擇性插入該方法可以插入表中所有字段(包括BLOB字段),但列配置了`<ignoreColumn>`屬性將不會插入.然而,參數對象`為空`的列將不會插入值.如果數據庫列設置了默認值則取默認值,否則列值是空. 對于列不允許為`空`情況-則需要人為確保調用該方法時不為空列確保有值使插入不報錯.**重要:**任何映射到java引用類型的字段都會被該方法插入. 如果表有主鍵自動增長(自動增長列或序列),table子元素配置`<generatedKey>`屬性,MBG會生成`<selectKey>`塊語句,一般情況下都不需要配置使用數據庫自動增長即可,除非表字段需要使用序列. **重要提示:**與iBATIS2和MyBatis3插入的差異.差異如下: | 運行 | 特性 | | --- | --- | | iBATIS2 | 配置了<generatedKey>屬性,插入的時候會返回新的自動增長值.沒有配置.沒有配置<generatedKey> 屬性, 插入返回值為`void`. | | MyBatis3 | 插入方法將返回插入受影響的行數(通常是0或者1). I配置了<generatedKey>屬性,自動增長值會被設置在參數對象中返回. | 如果table配置了enableInsert屬性為true,MBG會生成該方法. ## 根據主鍵更新該方法按照主鍵修改一行數據.該方法會修改表中所有字段,除非: * 列配置了`<ignoreColumn>`屬性 * BLOB字段(詳見根據主鍵更新包含BLOB字段) 數據庫表中存在主鍵且table配置了enableUpdateByPrimaryKey屬性為true,MBG會生成該方法. ## 根據主鍵更新包含BLOB字段該方法按照主鍵修改一行數據.該方法會修改表中所有字段(包括BLOB字段),除非: * 列配置了`<ignoreColumn>`屬性數據庫表中存在主鍵包含BLOB列且table配置了enableUpdateByPrimaryKey屬性為true,MBG會生成該方法. ## 根據主鍵選擇性更新該方法按照主鍵修改一行數據.該方法會更新表中參數對象屬性不為空的列.該方法可以被使用更新某些特定的列而不影響所有列數據. **重要:** 任何映射到java引用類型的字段都會被該方法更新. 數據庫表中存在主鍵且table配置了enableUpdateByPrimaryKey屬性為true,MBG會生成該方法. ## 根據主鍵刪除記錄該方法按照主鍵刪除一行數據. 數據庫表中存在主鍵且table配置了enableDeleteByPrimaryKey屬性為true,MBG會生成該方法. ## 根據條件刪除記錄該方法按照條件將刪除一行或者多行數據. **重要:**條件為空或者沒有設置條件時, 會將表中**所有**記錄刪除. 如果table配置了enableDeleteByExample屬性為true,MBG會生成該方法. ## 根據條件查詢記錄總數該方法按照條件查詢表中符合條件記錄的記錄總數. **重要:**條件為空或者沒有設置條件時,返回表中所有記錄總數. 如果table配置了enableCountByExample屬性為true,MBG會生成該方法. ## 根據條件更新記錄該方法按照條件更新表中符合條件記錄.該方法會修改表中所有字段,除非: * 列配置了`<ignoreColumn>`屬性 * BLOB字段(詳見根據條件修改記錄包含BLOB字段) **重要:**條件為空或者沒有設置條件時, 會將表中**所有**記錄更新. 如果table配置了enableUpdateByExample屬性為true,MBG會生成該方法. ## 根據條件修改記錄包含BLOB字段該方法按照條件更新表中符合條件記錄.該方法會修改表中所有字段(包括BLOB字段),除非: * 列配置了`<ignoreColumn>`屬性 **重要:**條件為空或者沒有設置條件時, 會將表中**所有**記錄更新. 如果表存在BLOB字段且table配置了enableUpdateByExample屬性為true,MBG會生成該方法. ## 根據條件選擇性更新記錄該方法按照條件更新表中符合條件記錄.該方法會更新表中參數對象屬性不為空的列.該方法可以被使用更新某些特定的列而不影響所有列數據.**重要:** 任何映射到java引用類型的字段都會被該方法更新. **重要:**條件為空或者沒有設置條件時, 會將表中**所有**記錄更新. 如果table配置了enableUpdateByExample屬性為true,MBG會生成該方法.