Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mybatis support mybatis-spring #463

Merged
merged 1 commit into from
Apr 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions plugin/hotswap-agent-mybatis-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
<properties>
<org.mybatis.version>3.5.9</org.mybatis.version>
<jaxb.version>2.3.0</jaxb.version>
<org.mybatis-spring.version>2.0.7</org.mybatis-spring.version>
<org.springframework.version>5.3.19</org.springframework.version>
</properties>


Expand All @@ -31,6 +33,33 @@
<version>${org.mybatis.version}</version>
</dependency>

<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>${org.mybatis-spring.version}</version>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>${org.springframework.version}</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${org.springframework.version}</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${org.springframework.version}</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.hsqldb</groupId>
<artifactId>hsqldb</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

import org.hotswap.agent.logging.AgentLogger;
import org.hotswap.agent.plugin.mybatis.proxy.ConfigurationProxy;
import org.hotswap.agent.plugin.mybatis.proxy.SpringMybatisConfigurationProxy;


/**
Expand All @@ -42,6 +43,7 @@ public class MyBatisRefreshCommands {
public static void reloadConfiguration() {
LOGGER.debug("Refreshing MyBatis configuration.");
ConfigurationProxy.refreshProxiedConfigurations();
SpringMybatisConfigurationProxy.refreshProxiedConfigurations();
LOGGER.reload("MyBatis configuration refreshed.");
reloadFlag = false;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
package org.hotswap.agent.plugin.mybatis.proxy;

import org.apache.ibatis.session.Configuration;
import org.hotswap.agent.javassist.util.proxy.MethodHandler;
import org.hotswap.agent.javassist.util.proxy.ProxyFactory;
import org.hotswap.agent.util.ReflectionHelper;

import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

public class SpringMybatisConfigurationProxy {

private static Map<Object, SpringMybatisConfigurationProxy> proxiedConfigurations = new HashMap<>();

public SpringMybatisConfigurationProxy(Object sqlSessionFactoryBean) {
this.sqlSessionFactoryBean = sqlSessionFactoryBean;
}

public static SpringMybatisConfigurationProxy getWrapper(Object sqlSessionFactoryBean) {
if (!proxiedConfigurations.containsKey(sqlSessionFactoryBean)) {
proxiedConfigurations.put(sqlSessionFactoryBean, new SpringMybatisConfigurationProxy(sqlSessionFactoryBean));
}
return proxiedConfigurations.get(sqlSessionFactoryBean);
}

public static void refreshProxiedConfigurations() {
for (SpringMybatisConfigurationProxy wrapper : proxiedConfigurations.values())
try {
wrapper.refreshProxiedConfiguration();
} catch (Exception e) {
e.printStackTrace();
}
}

public void refreshProxiedConfiguration() {
Object newSqlSessionFactory = ReflectionHelper.invoke(this.sqlSessionFactoryBean, "buildSqlSessionFactory");
this.configuration = (Configuration) ReflectionHelper.get(newSqlSessionFactory, "configuration");
}

private Object sqlSessionFactoryBean;
private Configuration configuration;
private Configuration proxyInstance;

public Configuration proxy(Configuration origConfiguration) {
this.configuration = origConfiguration;
if (proxyInstance == null) {
ProxyFactory factory = new ProxyFactory();
factory.setSuperclass(Configuration.class);

MethodHandler handler = new MethodHandler() {
@Override
public Object invoke(Object self, Method overridden, Method forwarder,
Object[] args) throws Throwable {
return overridden.invoke(configuration, args);
}
};

try {
proxyInstance = (Configuration) factory.create(new Class[0], null, handler);
} catch (Exception e) {
throw new Error("Unable instantiate Configuration proxy", e);
}
}
return proxyInstance;
}



}
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import org.hotswap.agent.logging.AgentLogger;
import org.hotswap.agent.plugin.mybatis.MyBatisPlugin;
import org.hotswap.agent.plugin.mybatis.proxy.ConfigurationProxy;
import org.hotswap.agent.plugin.mybatis.proxy.SpringMybatisConfigurationProxy;
import org.hotswap.agent.util.PluginManagerInvoker;

/**
Expand All @@ -46,6 +47,11 @@ public class MyBatisTransformers {
public static final String REFRESH_DOCUMENT_METHOD = "$$ha$refreshDocument";
public static final String REFRESH_METHOD = "$$ha$refresh";

private static final String INITIALIZED_FIELD = "$$ha$initialized";
private static final String FACTORYBEAN_FIELD = "$$ha$factoryBean";
public static final String FACTORYBEAN_SET_METHOD = "$$ha$setFactoryBean";
public static final String CONFIGURATION_PROXY_METHOD = "$$ha$proxySqlSessionFactoryConfiguration";

@OnClassLoadEvent(classNameRegexp = "org.apache.ibatis.parsing.XPathParser")
public static void patchXPathParser(CtClass ctClass, ClassPool classPool) throws NotFoundException, CannotCompileException {
CtClass stringClass = classPool.get("java.lang.String");
Expand Down Expand Up @@ -123,4 +129,58 @@ public static void patchXMLMapperBuilder(CtClass ctClass, ClassPool classPool) t
constructor.insertAfter(src.toString());
LOGGER.debug("org.apache.ibatis.builder.xml.XMLMapperBuilder patched.");
}

@OnClassLoadEvent(classNameRegexp = "org.apache.ibatis.session.SqlSessionFactoryBuilder")
public static void patchSqlSessionFactoryBuilder(CtClass ctClass, ClassPool classPool) throws NotFoundException, CannotCompileException {
// add $$ha$factoryBean field
CtClass objClass = classPool.get("java.lang.Object");
CtField factoryBeanField = new CtField(objClass, FACTORYBEAN_FIELD, ctClass);
ctClass.addField(factoryBeanField);

CtMethod setMethod = CtNewMethod.make(
"public void " + FACTORYBEAN_SET_METHOD + "(Object factoryBean) {" +
"this." + FACTORYBEAN_FIELD + " = factoryBean;" +
"}", ctClass);
ctClass.addMethod(setMethod);

CtMethod buildMethod = ctClass.getDeclaredMethod("build",
new CtClass[] {classPool.get("org.apache.ibatis.session.Configuration")});
buildMethod.insertBefore("{" +
"if (this." + FACTORYBEAN_FIELD + " != null) {" +
"config = " + SqlSessionFactoryBeanCaller.class.getName() + ".proxyConfiguration(this." + FACTORYBEAN_FIELD + ", config);" +
"}" +
"}"
);
LOGGER.debug("org.apache.ibatis.session.SqlSessionFactoryBuilder patched.");
}

@OnClassLoadEvent(classNameRegexp = "org.mybatis.spring.SqlSessionFactoryBean")
public static void patchSqlSessionFactoryBean(CtClass ctClass, ClassPool classPool) throws NotFoundException, CannotCompileException {
// add $$ha$initialized field
CtClass booleanClass = classPool.get(boolean.class.getName());
CtField sourceFileField = new CtField(booleanClass, INITIALIZED_FIELD, ctClass);
ctClass.addField(sourceFileField);

CtMethod method = ctClass.getDeclaredMethod("afterPropertiesSet");
method.insertAfter("{" +
"this." + INITIALIZED_FIELD + " = true;" +
"}"
);

CtConstructor constructor = ctClass.getDeclaredConstructor(new CtClass[] {});
constructor.insertAfter("{" +
SqlSessionFactoryBeanCaller.class.getName() + ".setFactoryBean(this.sqlSessionFactoryBuilder, this);" +
"}");

CtMethod proxyMethod = CtNewMethod.make(
"public org.apache.ibatis.session.Configuration " + CONFIGURATION_PROXY_METHOD + "(org.apache.ibatis.session.Configuration configuration) {" +
"if(this." + INITIALIZED_FIELD + ") {" +
"return configuration;" +
"} else {" +
"return " + SpringMybatisConfigurationProxy.class.getName() + ".getWrapper(this).proxy(configuration);" +
"}" +
"}", ctClass);
ctClass.addMethod(proxyMethod);
LOGGER.debug("org.mybatis.spring.SqlSessionFactoryBean patched.");
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package org.hotswap.agent.plugin.mybatis.transformers;

import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.hotswap.agent.util.ReflectionHelper;
import org.mybatis.spring.SqlSessionFactoryBean;

public class SqlSessionFactoryBeanCaller {

public static Configuration proxyConfiguration(Object factoryBean, Configuration configuration) {
return (Configuration) ReflectionHelper.invoke(factoryBean, SqlSessionFactoryBean.class,
MyBatisTransformers.CONFIGURATION_PROXY_METHOD, new Class[] {Configuration.class}, configuration);
}

public static void setFactoryBean(SqlSessionFactoryBuilder builder, Object factoryBean) {
ReflectionHelper.invoke(builder, SqlSessionFactoryBuilder.class,
MyBatisTransformers.FACTORYBEAN_SET_METHOD, new Class[] {Object.class}, factoryBean);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.hotswap.agent.util.test.WaitHelper;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;

Expand All @@ -49,8 +50,6 @@ public static void setup() throws Exception {
// create an SqlSessionFactory
File f = Resources.getResourceAsFile("org/hotswap/agent/plugin/mybatis/Mapper1.xml");
Files.copy(f.toPath(), f.toPath().getParent().resolve("Mapper.xml"));
File tmp = Resources.getResourceAsFile("org/hotswap/agent/plugin/mybatis/Mapper.xml");
tmp.deleteOnExit();
try (Reader reader = Resources.getResourceAsReader("org/hotswap/agent/plugin/mybatis/mybatis-config.xml")) {
sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
}
Expand All @@ -60,7 +59,13 @@ public static void setup() throws Exception {
"org/hotswap/agent/plugin/mybatis/CreateDB.sql");
}

private static void runScript(DataSource ds, String resource) throws IOException, SQLException {
@AfterClass
public static void tearDown() throws Exception {
File tmp = Resources.getResourceAsFile("org/hotswap/agent/plugin/mybatis/Mapper.xml");
tmp.delete();
}

protected static void runScript(DataSource ds, String resource) throws IOException, SQLException {
try (Connection connection = ds.getConnection()) {
ScriptRunner runner = new ScriptRunner(connection);
runner.setAutoCommit(true);
Expand Down Expand Up @@ -93,7 +98,7 @@ public void testUserFromAnnotation() throws Exception {
}
}

private void swapMapper(String mapperNew) throws Exception {
protected static void swapMapper(String mapperNew) throws Exception {
MyBatisRefreshCommands.reloadFlag = true;
File f = Resources.getResourceAsFile(mapperNew);
Files.copy(f.toPath(), f.toPath().getParent().resolve("Mapper.xml"), StandardCopyOption.REPLACE_EXISTING);
Expand All @@ -102,7 +107,7 @@ private void swapMapper(String mapperNew) throws Exception {
public boolean result() throws Exception {
return !MyBatisRefreshCommands.reloadFlag;
}
}, 2000 )); // Repository is regenerated within 2*DeltaSpikePlugin.WAIT_ON_REDEFINE
}, 4000 )); // Repository is regenerated within 2*DeltaSpikePlugin.WAIT_ON_REDEFINE

// TODO do not know why sleep is needed, maybe a separate thread in owb refresh?
Thread.sleep(100);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
package org.hotswap.agent.plugin.mybatis;

import org.apache.ibatis.io.Resources;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import javax.sql.DataSource;
import java.io.File;
import java.nio.file.Files;

import static org.junit.Assert.assertEquals;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = { "classpath:spring-mybatis.xml" })
public class MybatisSpringTest {

@Autowired
ApplicationContext applicationContext;

@Autowired
Mapper mapper;

@Autowired
DataSource dataSource;

@BeforeClass
public static void setup() throws Exception {
File f = Resources.getResourceAsFile("org/hotswap/agent/plugin/mybatis/Mapper1.xml");
Files.copy(f.toPath(), f.toPath().getParent().resolve("Mapper.xml"));
}

@AfterClass
public static void tearDown() throws Exception {
File tmp = Resources.getResourceAsFile("org/hotswap/agent/plugin/mybatis/Mapper.xml");
tmp.delete();
}

@Before
public void init() throws Exception {
MyBatisPluginTest.runScript(dataSource, "org/hotswap/agent/plugin/mybatis/CreateDB.sql");
}

@Test
public void testUserFromAnnotation() throws Exception {
User user = mapper.getUserXML("User1");
assertEquals("User1", user.getName1());

MyBatisPluginTest.swapMapper("org/hotswap/agent/plugin/mybatis/Mapper2.xml");
user = mapper.getUserXML("User1");
assertEquals("User2", user.getName1());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
<constructor-arg ref="sqlSessionFactory"/>
</bean>

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="mapperLocations" value="org/hotswap/agent/plugin/mybatis/Mapper.xml"/>
</bean>

<bean id="dataSource" class="org.springframework.jdbc.datasource.SimpleDriverDataSource" >
<property name="username" value="sa" />
<property name="driver" ref="hSqldriver" />
<property name="url" value="jdbc:hsqldb:mem:maptypehandler" />
</bean>
<bean id="hSqldriver" class="org.hsqldb.jdbcDriver"/>

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer" >
<property name="basePackage" value="org.hotswap.agent.plugin.mybatis"/>
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
</bean>
</beans>