MyBatis中l(wèi)ocalOutputParameterCache的作用

縱覽全網幾乎沒有人對localOutputParameterCache做過解釋可免，嘿嘿逞泄，那我嘗試來解釋下斑鸦。

首先勺择，既然你想知道localOutputParameterCache的作用，我就當你知道localCache（MyBatis的一級緩存）涩嚣。然后崇众，我告訴你localOutputParameterCache也是一級緩存，只不過它作用的不是我們理論上的返回結果航厚，而是我們請求的參數（可以是DO）顷歌，更進一步說他是對存儲過程的一種緩存，下面我為大家11介紹幔睬。

1眯漩、localOutputParameterCache的創(chuàng)建時機

// class BaseExecutor
protected BaseExecutor(Configuration configuration, Transaction transaction) {
    this.transaction = transaction;
    this.deferredLoads = new ConcurrentLinkedQueue<>();
    this.localCache = new PerpetualCache("LocalCache");
    // 創(chuàng)建時機在Executor創(chuàng)建的時候，和localCache一起被創(chuàng)建
    this.localOutputParameterCache = new PerpetualCache("LocalOutputParameterCache");
    this.closed = false;
    this.configuration = configuration;
    this.wrapper = this;
  }

2、設置Object parameter（請求參數）值

  // class DefaultResultSetHandler
  @Override
  public void handleOutputParameters(CallableStatement cs) throws SQLException {
    final Object parameterObject = parameterHandler.getParameterObject();
    final MetaObject metaParam = configuration.newMetaObject(parameterObject);
    final List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
    for (int i = 0; i < parameterMappings.size(); i++) {
      final ParameterMapping parameterMapping = parameterMappings.get(i);
      // 只有mode值為：OUT或INOUT時赦抖，才進行存儲過程返回結果的設置
      if (parameterMapping.getMode() == ParameterMode.OUT || parameterMapping.getMode() == ParameterMode.INOUT) {
        if (ResultSet.class.equals(parameterMapping.getJavaType())) {
          handleRefCursorOutputParameter((ResultSet) cs.getObject(i + 1), parameterMapping, metaParam);
        } else {
          final TypeHandler<?> typeHandler = parameterMapping.getTypeHandler();
          // 從存儲過程中獲取到的值舱卡，設置到請求參數的映射中
          metaParam.setValue(parameterMapping.getProperty(), typeHandler.getResult(cs, i + 1));
        }
      }
    }
  }

這樣設置的結果：是將存儲過程中的返回結果設置到Object parameter中，可以打斷點進行查看驗證队萤。

3轮锥、使用的時機-設置值

// class BaseExecutor
private <E> List<E> queryFromDatabase(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    List<E> list;
    localCache.putObject(key, EXECUTION_PLACEHOLDER);
    try {
      list = doQuery(ms, parameter, rowBounds, resultHandler, boundSql);
    } finally {
      localCache.removeObject(key);
    }
    localCache.putObject(key, list);
    if (ms.getStatementType() == StatementType.CALLABLE) {
      // 注意：只有在statementType="CALLABLE"的時候，設置值
      localOutputParameterCache.putObject(key, parameter);
    }
    return list;
  }

這樣設置的結果：是將封裝好的Object parameter的結果設置到localOutputParameterCache中要尔。

4舍杜、使用的時機-獲取設置的值

// class BaseExecutor
private void handleLocallyCachedOutputParameters(MappedStatement ms, CacheKey key, Object parameter, BoundSql boundSql) {
    if (ms.getStatementType() == StatementType.CALLABLE) {
      // 從localOutputParameterCache獲取緩存的值
      final Object cachedParameter = localOutputParameterCache.getObject(key);
      if (cachedParameter != null && parameter != null) {
        final MetaObject metaCachedParameter = configuration.newMetaObject(cachedParameter);
        final MetaObject metaParameter = configuration.newMetaObject(parameter);
        for (ParameterMapping parameterMapping : boundSql.getParameterMappings()) {
          if (parameterMapping.getMode() != ParameterMode.IN) {
            final String parameterName = parameterMapping.getProperty();
            final Object cachedValue = metaCachedParameter.getValue(parameterName);
            // 將緩存中的值設置到Object parameter請求參數中
            metaParameter.setValue(parameterName, cachedValue);
          }
        }
      }
    }
  }

這樣做的結果：就是從localOutputParameterCache中查存儲過程的結果，而不是去調數據庫赵辕。

總結：localOutputParameterCache也是一級緩存既绩，只不過是用來緩存存儲過程的返回結果。

補充：分享一個不完整的小demo（我理解的看到這最起碼你的應用也有了）还惠，大家可以進行調試時使用：

1熬词、表SQL

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for tbl_employee
-- ----------------------------
DROP TABLE IF EXISTS `tbl_employee`;
CREATE TABLE `tbl_employee`  (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `last_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
  `gender` char(1) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
  `email` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL,
  `gmt_create` datetime(0) NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 6 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Compact;

SET FOREIGN_KEY_CHECKS = 1;

2、簡單的存儲過程

CREATE DEFINER=`root`@`localhost` PROCEDURE `get_employee_by_procedure`(
    IN inputId INT,
    OUT lastName VARCHAR(256),
    OUT gender CHAR,
    OUT email VARCHAR(256),
    OUT get_create DATETIME
)
BEGIN
SELECT
e.last_name, e.gender, e.email, e.gmt_create
INTO lastName, gender, email, get_create
FROM tbl_employee e WHERE e.id = inputId;
END

簡單說明吸重，在Navicat中對應數據庫下的函數下進行保存即可：


存儲過程在Navicat中的設置

3互拾、編寫Mapper.xml的映射

<!-- 
    useCache="false"是避免二級緩存對其影響，查看源碼自行了解嚎幸；
    statementType="CALLABLE"是開啟使用該localOutputParameterCache緩存颜矿，具體含義查看官方文檔即可
 -->
<select id="getEmpByProcedure" useCache="false" statementType="CALLABLE">
    {CALL get_employee_by_procedure(
        #{id, mode=IN, jdbcType=INTEGER},
        #{lastName, mode=OUT, jdbcType=VARCHAR, javaType=java.lang.String},
        #{email, mode=OUT, jdbcType=CHAR, javaType=java.lang.String},
        #{gender, mode=OUT, jdbcType=VARCHAR, javaType=java.lang.String},
        #{gmtCreate, mode=OUT, jdbcType=DATE, javaType=java.util.Date}
    )}
</select>

4、編寫Mapper接口方法

public interface EmployeeMapper {

    /**
     * 通過存儲過程查詢員工信息（無返回結果）
     * @param employee 員工對象
     */
    void getEmpByProcedure(Employee employee);
}

注意：存儲過程的返回結果會封裝在請求參數中嫉晶，所以請求參數中要包含返回的參數骑疆。

5、編寫DO

@Data
public class Employee implements Serializable {
    private static final long serialVersionUID = -6843908059513315549L;

    private Integer id;
    private String lastName;
    /** 0：女替废；1：男 */
    private String gender;
    private String email;
    private Date gmtCreate;
}

6箍铭、編寫測試方法

@Slf4j
public class ProcedureTest {

    private SqlSessionFactory getSqlSessionFactory() throws IOException {
        try (InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml")) {
            return new SqlSessionFactoryBuilder().build(inputStream);
        }
    }

    @Test
    public void procedureTest() throws IOException {
        // 1、獲取sqlSessionFactory對象
        SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
        // 2椎镣、獲取sqlSession對象
        try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
            // 3诈火、獲取接口實現類對象
            EmployeeMapper mapper1 = sqlSession.getMapper(EmployeeMapper.class);
            EmployeeMapper mapper2 = sqlSession.getMapper(EmployeeMapper.class);

            // mapper1查詢
            Employee employee1 = new Employee();
            employee1.setId(1);
            mapper1.getEmpByProcedure(employee1);

            // mapper2查詢
            Employee employee2 = new Employee();
            employee2.setId(1);
            mapper2.getEmpByProcedure(employee2);

            System.out.println(employee1);
            System.out.println(employee2);
            // mapper1和mapper2的查詢結果中引用對象比較：
            // 比較地址值是否相等，從而說明是否使用了一級緩存
            System.out.println(employee1.getGmtCreate() == employee2.getGmtCreate());
        } catch (Exception e) {
            log.error("error: {}", e, e.getMessage());
        }
    }
}

說明：大家可以通過使用關閉一級緩存的方法將一級緩存關閉后状答，查看運行結果冷守，從而進一步論證localOutputParameterCache就是“一級緩存”。

你會發(fā)現：
在不關閉一級緩存的情況下惊科，對象中的引用屬性的值比較是：true
而在關閉一級緩存的情況下拍摇，對象中的引用屬性的值比較是：false

關閉一級緩存的方式可以是：

<select id="getEmpByProcedure" useCache="false" statementType="CALLABLE" flushCache="true">
    {CALL get_employee_by_procedure(
        #{id, mode=IN, jdbcType=INTEGER},
        #{lastName, mode=OUT, jdbcType=VARCHAR, javaType=java.lang.String},
        #{email, mode=OUT, jdbcType=CHAR, javaType=java.lang.String},
        #{gender, mode=OUT, jdbcType=VARCHAR, javaType=java.lang.String},
        #{gmtCreate, mode=OUT, jdbcType=DATE, javaType=java.util.Date}
    )}
</select>

沒錯，就是在標簽中添加 flushCache="true"即可馆截。

希望這篇文章能解決你的困惑充活，幫忙點個贊不過分吧。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末，一起剝皮案震驚了整個濱河市混卵，隨后出現的幾起案子映穗，更是在濱河造成了極大的恐慌，老刑警劉巖淮菠，帶你破解...
    沈念sama閱讀 206,482評論 6贊 481
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件男公，死亡現場離奇詭異荤堪，居然都是意外死亡合陵，警方通過查閱死者的電腦和手機，發(fā)現死者居然都...
    沈念sama閱讀 88,377評論 2贊 382
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門澄阳，熙熙樓的掌柜王于貴愁眉苦臉地迎上來拥知，“玉大人，你說我怎么就攤上這事碎赢〉吞蓿” “怎么了？”我有些...
    開封第一講書人閱讀 152,762評論 0贊 342
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵肮塞，是天一觀的道長襟齿。 經常有香客問我，道長枕赵，這世上最難降的妖魔是什么猜欺？ 我笑而不...
    開封第一講書人閱讀 55,273評論 1贊 279
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮拷窜，結果婚禮上开皿，老公的妹妹穿的比我還像新娘。我一直安慰自己篮昧，他們只是感情好赋荆，可當我...
    茶點故事閱讀 64,289評論 5贊 373
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著懊昨，像睡著了一般窄潭。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上酵颁，一...
    開封第一講書人閱讀 49,046評論 1贊 285
  • 城市分裂傳說
    那天狈孔，我揣著相機與錄音，去河邊找鬼材义。 笑死均抽，一個胖子當著我的面吹牛，可吹牛的內容都是我干的其掂。 我是一名探鬼主播油挥，決...
    沈念sama閱讀 38,351評論 3贊 400
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了深寥？” 一聲冷哼從身側響起攘乒，我...
    開封第一講書人閱讀 36,988評論 0贊 259
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎惋鹅，沒想到半個月后则酝，有當地人在樹林里發(fā)現了一具尸體，經...
    沈念sama閱讀 43,476評論 1贊 300
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡闰集，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,948評論 2贊 324
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年沽讹，在試婚紗的時候發(fā)現自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片武鲁。...
    茶點故事閱讀 38,064評論 1贊 333
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡爽雄，死狀恐怖，靈堂內的尸體忽然破棺而出沐鼠，到底是詐尸還是另有隱情挚瘟，我是刑警寧澤，帶...
    沈念sama閱讀 33,712評論 4贊 323
  • ?日本核電站爆炸內幕
    正文 年R本政府宣布饲梭，位于F島的核電站乘盖，受9級特大地震影響，放射性物質發(fā)生泄漏憔涉。R本人自食惡果不足惜订框，卻給世界環(huán)境...
    茶點故事閱讀 39,261評論 3贊 307
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望监氢。 院中可真熱鬧布蔗，春花似錦、人聲如沸浪腐。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,264評論 0贊 19
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽议街。三九已至泽谨，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間特漩，已是汗流浹背吧雹。 一陣腳步聲響...
    開封第一講書人閱讀 31,486評論 1贊 262
  • 情欲美人皮
    我被黑心中介騙來泰國打工， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留涂身，地道東北人雄卷。 一個月前我還...
    沈念sama閱讀 45,511評論 2贊 354
  • 代替公主和親
    正文 我出身青樓，卻偏偏與公主長得像蛤售，于是被迫代替她去往敵國和親丁鹉。 傳聞我的和親對象是個殘疾皇子妒潭，可洞房花燭夜當晚...
    茶點故事閱讀 42,802評論 2贊 345