Fixed the flush ability of select mappers. They will now clear the local internal session cache when flushCache="true".

Author: nmaves

src/main/java/org/apache/ibatis/executor/BaseExecutor.java

@@ -101,6 +101,11 @@ public List<BatchResult> flushStatements(boolean isRollBack) throws SQLException
   public List query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
     ErrorContext.instance().resource(ms.getResource()).activity("executing a query").object(ms.getId());
     if (closed) throw new ExecutorException("Executor was closed.");
+
+    // Flush the internal cache is force is true
+    if (ms.isFlushCacheRequired()) {
+        clearLocalCache();
+    }
     List list;
     try {
       queryStack++;

src/test/java/org/apache/ibatis/submitted/force_flush_on_select/CreateDB.sql

@@ -0,0 +1,14 @@
+create table person (
+  id int,
+  firstName varchar(100),
+  lastName varchar(100)
+);
+
+INSERT INTO person (id, firstName, lastName)
+VALUES (1, 'John', 'Smith');
+
+INSERT INTO person (id, firstName, lastName)
+VALUES (2, 'Christian', 'Poitras');
+
+INSERT INTO person (id, firstName, lastName)
+VALUES (3, 'Clinton', 'Begin');

src/test/java/org/apache/ibatis/submitted/force_flush_on_select/ForceFlushOnSelectTest.java

@@ -0,0 +1,92 @@
+package org.apache.ibatis.submitted.force_flush_on_select;
+
+import java.io.Reader;
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.util.List;
+
+import org.apache.ibatis.io.Resources;
+import org.apache.ibatis.jdbc.ScriptRunner;
+import org.apache.ibatis.session.ExecutorType;
+import org.apache.ibatis.session.SqlSession;
+import org.apache.ibatis.session.SqlSessionFactory;
+import org.apache.ibatis.session.SqlSessionFactoryBuilder;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+public class ForceFlushOnSelectTest {
+    
+    private static SqlSessionFactory sqlSessionFactory;
+    
+    @BeforeClass
+    public static void initDatabase() throws Exception {
+        Connection conn = null;
+
+        try {
+            Class.forName("org.hsqldb.jdbcDriver");
+            conn = DriverManager.getConnection("jdbc:hsqldb:mem:force_flush_on_select", "sa", "");
+
+            Reader reader = Resources.getResourceAsReader("org/apache/ibatis/submitted/force_flush_on_select/CreateDB.sql");
+
+            ScriptRunner runner = new ScriptRunner(conn);
+            runner.setLogWriter(null);
+            runner.setErrorLogWriter(null);
+            runner.runScript(reader);
+            conn.commit();
+            reader.close();
+
+            reader = Resources.getResourceAsReader("org/apache/ibatis/submitted/force_flush_on_select/ibatisConfig.xml");
+            sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
+            reader.close();
+        } finally {
+            if (conn != null) {
+                conn.close();
+            }
+        }
+    }
+    
+    @Test
+    public void testShouldFlushLocalSessionCacheOnQuery() {
+        SqlSession sqlSession = sqlSessionFactory.openSession(ExecutorType.SIMPLE);
+        try {
+            PersonMapper personMapper = sqlSession.getMapper(PersonMapper.class);
+            Person person = personMapper.selectById(1);
+            person.setFirstName("Simone");
+            
+            personMapper.update(person);
+
+            Person updatedPerson = personMapper.selectById(1);
+
+            assertEquals("Simone", updatedPerson.getFirstName());
+
+            sqlSession.commit();
+        } finally {
+        	sqlSession.close();
+        }
+    }
+
+    @Test
+    public void testShouldFlushLocalSessionCacheOnQueryForList() {
+        SqlSession sqlSession = sqlSessionFactory.openSession(ExecutorType.SIMPLE);
+        try {
+            PersonMapper personMapper = sqlSession.getMapper(PersonMapper.class);
+            List<Person> people = personMapper.selectAll();
+
+            Person person = people.get(0);
+            person.setFirstName("Simone");
+
+            personMapper.update(person);
+
+            people = personMapper.selectAll();
+
+            assertEquals("Simone", people.get(0).getFirstName());
+
+            sqlSession.commit();
+        } finally {
+        	sqlSession.close();
+        }
+    }
+
+}

src/test/java/org/apache/ibatis/submitted/force_flush_on_select/Person.java

@@ -0,0 +1,27 @@
+package org.apache.ibatis.submitted.force_flush_on_select;
+
+import java.io.Serializable;
+
+public class Person implements Serializable {
+    private Integer id;
+    private String firstName;
+    private String lastName;
+    public String getFirstName() {
+        return firstName;
+    }
+    public void setFirstName(String firstName) {
+        this.firstName = firstName;
+    }
+    public String getLastName() {
+        return lastName;
+    }
+    public void setLastName(String lastName) {
+        this.lastName = lastName;
+    }
+    public Integer getId() {
+        return id;
+    }
+    public void setId(Integer id) {
+        this.id = id;
+    }
+}

src/test/java/org/apache/ibatis/submitted/force_flush_on_select/Person.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE mapper
+    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
+    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
+
+<mapper namespace="org.apache.ibatis.submitted.force_flush_on_select.PersonMapper">
+
+    <!-- One hour cache -->
+	<cache flushInterval="3600000"/>
+    
+    <resultMap id="personMap" type="Person">
+        <id property="id" column="id"/>
+        <result property="firstName" column="firstName"/>
+        <result property="lastName" column="lastName"/>
+    </resultMap>
+    
+    
+    <select id="selectById" resultMap="personMap" parameterType="int">
+        SELECT id, firstName, lastName
+        FROM person
+        WHERE id = #{id}
+    </select>
+
+    <select id="selectAll" resultMap="personMap">
+        SELECT id, firstName, lastName
+        FROM person
+        ORDER BY id
+    </select>
+
+    <!-- normally this would be a stored procedure or a function -->
+    <select id="update" parameterType="Person" resultType="Person" flushCache="true">
+        UPDATE person
+        SET firstName = #{firstName},
+        lastName = #{lastName}
+        WHERE id = #{id}
+    </select>
+</mapper>

src/test/java/org/apache/ibatis/submitted/force_flush_on_select/PersonMapper.java

@@ -0,0 +1,9 @@
+package org.apache.ibatis.submitted.force_flush_on_select;
+
+import java.util.List;
+
+public interface PersonMapper {
+    public Person selectById(int id);
+    public List<Person> selectAll();
+    public void update(Person person);
+}

src/test/java/org/apache/ibatis/submitted/force_flush_on_select/ibatisConfig.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE configuration
+    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
+    "http://mybatis.org/dtd/mybatis-3-config.dtd">
+
+<configuration>
+    <typeAliases>
+        <typeAlias alias="Person" type="org.apache.ibatis.submitted.force_flush_on_select.Person"/>
+    </typeAliases>
+    
+    <environments default="test">
+        <environment id="test">
+            <transactionManager type="JDBC"></transactionManager>
+            <dataSource type="UNPOOLED">
+                <property name="driver" value="org.hsqldb.jdbcDriver"/>
+                <property name="url" value="jdbc:hsqldb:mem:force_flush_on_select"/>
+                <property name="username" value="sa"/>
+            </dataSource>
+        </environment>
+    </environments>
+    
+    <mappers>
+        <mapper resource="org/apache/ibatis/submitted/force_flush_on_select/Person.xml"/>
+    </mappers>
+</configuration>