diff --git a/pom.xml b/pom.xml index 1544f0b..38555ac 100644 --- a/pom.xml +++ b/pom.xml @@ -57,7 +57,25 @@ junit junit - 3.8.1 + 4.12 + test + + + org.mybatis + mybatis + 3.4.0 + test + + + ch.qos.logback + logback-classic + 1.1.7 + test + + + mysql + mysql-connector-java + 5.1.40 test diff --git a/src/test/java/com/itfsw/mybatis/generator/plugins/DBHelperTest.java b/src/test/java/com/itfsw/mybatis/generator/plugins/DBHelperTest.java new file mode 100644 index 0000000..f2c051f --- /dev/null +++ b/src/test/java/com/itfsw/mybatis/generator/plugins/DBHelperTest.java @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2017. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.itfsw.mybatis.generator.plugins; + +import com.itfsw.mybatis.generator.plugins.tools.DBHelper; +import org.apache.ibatis.session.SqlSession; +import org.junit.Assert; +import org.junit.Test; + +import java.io.IOException; +import java.sql.Connection; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; + +/** + * --------------------------------------------------------------------------- + * + * --------------------------------------------------------------------------- + * @author: hewei + * @time:2017/6/26 17:19 + * --------------------------------------------------------------------------- + */ +public class DBHelperTest { + /** + * 测试 getSqlSession + * + * @throws IOException + * @throws SQLException + */ + @Test + public void testGetSqlSession() throws IOException, SQLException { + DBHelper helper = DBHelper.getHelper("scripts/test_init.sql"); + SqlSession sqlSession = helper.getSqlSession(); + Connection connection = sqlSession.getConnection(); + Statement statement = connection.createStatement(); + + // 执行查询 + statement.execute("SELECT COUNT(*) as total FROM tb"); + ResultSet resultSet = statement.getResultSet(); + + resultSet.first(); + Assert.assertEquals(resultSet.getInt("total"), 4); + + statement.close(); + connection.close(); + sqlSession.close(); + } +} diff --git a/src/test/java/com/itfsw/mybatis/generator/plugins/tools/DBHelper.java b/src/test/java/com/itfsw/mybatis/generator/plugins/tools/DBHelper.java new file mode 100644 index 0000000..390feec --- /dev/null +++ b/src/test/java/com/itfsw/mybatis/generator/plugins/tools/DBHelper.java @@ -0,0 +1,110 @@ +/* + * Copyright (c) 2017. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.itfsw.mybatis.generator.plugins.tools; + +import org.apache.ibatis.io.Resources; +import org.apache.ibatis.session.SqlSession; +import org.apache.ibatis.session.SqlSessionFactory; +import org.apache.ibatis.session.SqlSessionFactoryBuilder; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.sql.Connection; +import java.sql.SQLException; +import java.sql.Statement; + +/** + * --------------------------------------------------------------------------- + * + * --------------------------------------------------------------------------- + * @author: hewei + * @time:2017/6/26 16:52 + * --------------------------------------------------------------------------- + */ +public class DBHelper { + private static final String MYBATIS_CONFIG = "mybatis-config.xml"; // 配置文件 + private static DBHelper helper; // helper + + /** + * 构造函数 + */ + private DBHelper() { + } + + /** + * 获取数据库操作工具 + * + * @param initSql + * @return + */ + public static DBHelper getHelper(String initSql) throws IOException, SQLException { + if (helper == null){ + helper = new DBHelper(); + helper.initDB(initSql); + } + return helper; + } + + /** + * 获取SqlSession + * + * @return + * @throws IOException + */ + public SqlSession getSqlSession() throws IOException { + InputStream inputStream = Resources.getResourceAsStream(MYBATIS_CONFIG); + SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); + inputStream.close(); + return sqlSessionFactory.openSession(true); + } + + /** + * 初始化数据库 + * + * @param initSql + * @throws IOException + * @throws SQLException + */ + private void initDB(String initSql) throws IOException, SQLException { + SqlSession sqlSession = this.getSqlSession(); + Connection connection = sqlSession.getConnection(); + Statement statement = connection.createStatement(); + // 获取建表和初始化sql + InputStream inputStream = Resources.getResourceAsStream(initSql); + InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "UTF-8"); + BufferedReader bufferedReader = new BufferedReader(inputStreamReader); + // 读取sql语句执行 + StringBuffer sb = new StringBuffer(); + String line; + while ((line = bufferedReader.readLine()) != null){ + sb.append(line).append("\n"); + if (line.matches(".*;$")){ + System.out.println(sb.toString()); + statement.execute(sb.toString()); + sb.setLength(0); + } + } + bufferedReader.close(); + inputStreamReader.close(); + inputStream.close(); + statement.close(); + connection.close(); + sqlSession.close(); + } +} diff --git a/src/test/java/com/itfsw/mybatis/generator/plugins/tools/SqlHelper.java b/src/test/java/com/itfsw/mybatis/generator/plugins/tools/SqlHelper.java new file mode 100644 index 0000000..0479686 --- /dev/null +++ b/src/test/java/com/itfsw/mybatis/generator/plugins/tools/SqlHelper.java @@ -0,0 +1,276 @@ +/* + * Copyright (c) 2017. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.itfsw.mybatis.generator.plugins.tools; + +import org.apache.ibatis.annotations.Param; +import org.apache.ibatis.mapping.BoundSql; +import org.apache.ibatis.mapping.MappedStatement; +import org.apache.ibatis.mapping.ParameterMapping; +import org.apache.ibatis.mapping.ParameterMode; +import org.apache.ibatis.reflection.MetaObject; +import org.apache.ibatis.reflection.SystemMetaObject; +import org.apache.ibatis.reflection.factory.DefaultObjectFactory; +import org.apache.ibatis.reflection.factory.ObjectFactory; +import org.apache.ibatis.reflection.wrapper.DefaultObjectWrapperFactory; +import org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory; +import org.apache.ibatis.session.Configuration; +import org.apache.ibatis.session.ResultHandler; +import org.apache.ibatis.session.RowBounds; +import org.apache.ibatis.session.SqlSession; +import org.apache.ibatis.type.JdbcType; +import org.apache.ibatis.type.TypeHandlerRegistry; + +import java.lang.reflect.Method; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * --------------------------------------------------------------------------- + * + * --------------------------------------------------------------------------- + * @author: hewei + * @time:2017/6/26 15:42 + * --------------------------------------------------------------------------- + */ +public class SqlHelper { + private static final ObjectFactory DEFAULT_OBJECT_FACTORY = new DefaultObjectFactory(); + private static final ObjectWrapperFactory DEFAULT_OBJECT_WRAPPER_FACTORY = new DefaultObjectWrapperFactory(); + + /** + * 通过接口获取sql + * @param mapper + * @param methodName + * @param args + * @return + */ + public static String getMapperSql(Object mapper, String methodName, Object... args) { + MetaObject metaObject = SystemMetaObject.forObject(mapper); + SqlSession session = (SqlSession) metaObject.getValue("h.sqlSession"); + Class mapperInterface = (Class) metaObject.getValue("h.mapperInterface"); + String fullMethodName = mapperInterface.getCanonicalName() + "." + methodName; + if (args == null || args.length == 0) { + return getNamespaceSql(session, fullMethodName, null); + } else { + return getMapperSql(session, mapperInterface, methodName, args); + } + } + + /** + * 通过Mapper方法名获取sql + * @param session + * @param fullMapperMethodName + * @param args + * @return + */ + public static String getMapperSql(SqlSession session, String fullMapperMethodName, Object... args) { + if (args == null || args.length == 0) { + return getNamespaceSql(session, fullMapperMethodName, null); + } + String methodName = fullMapperMethodName.substring(fullMapperMethodName.lastIndexOf('.') + 1); + Class mapperInterface = null; + try { + mapperInterface = Class.forName(fullMapperMethodName.substring(0, fullMapperMethodName.lastIndexOf('.'))); + return getMapperSql(session, mapperInterface, methodName, args); + } catch (ClassNotFoundException e) { + throw new IllegalArgumentException("参数" + fullMapperMethodName + "无效!"); + } + } + + /** + * 通过Mapper接口和方法名 + * @param session + * @param mapperInterface + * @param methodName + * @param args + * @return + */ + public static String getMapperSql(SqlSession session, Class mapperInterface, String methodName, Object... args) { + String fullMapperMethodName = mapperInterface.getCanonicalName() + "." + methodName; + if (args == null || args.length == 0) { + return getNamespaceSql(session, fullMapperMethodName, null); + } + Method method = getDeclaredMethods(mapperInterface, methodName); + Map params = new HashMap(); + final Class[] argTypes = method.getParameterTypes(); + for (int i = 0; i < argTypes.length; i++) { + if (!RowBounds.class.isAssignableFrom(argTypes[i]) && !ResultHandler.class.isAssignableFrom(argTypes[i])) { + String paramName = "param" + String.valueOf(params.size() + 1); + paramName = getParamNameFromAnnotation(method, i, paramName); + params.put(paramName, i >= args.length ? null : args[i]); + } + } + if (args != null && args.length == 1) { + Object _params = wrapCollection(args[0]); + if (_params instanceof Map) { + params.putAll((Map) _params); + } + } + return getNamespaceSql(session, fullMapperMethodName, params); + } + + + /** + * 通过命名空间方式获取sql + * @param session + * @param namespace + * @return + */ + public static String getNamespaceSql(SqlSession session, String namespace) { + return getNamespaceSql(session, namespace, null); + } + + /** + * 通过命名空间方式获取sql + * @param session + * @param namespace + * @param params + * @return + */ + public static String getNamespaceSql(SqlSession session, String namespace, Object params) { + params = wrapCollection(params); + Configuration configuration = session.getConfiguration(); + MappedStatement mappedStatement = configuration.getMappedStatement(namespace); + TypeHandlerRegistry typeHandlerRegistry = mappedStatement.getConfiguration().getTypeHandlerRegistry(); + BoundSql boundSql = mappedStatement.getBoundSql(params); + List parameterMappings = boundSql.getParameterMappings(); + String sql = boundSql.getSql(); + if (parameterMappings != null) { + for (int i = 0; i < parameterMappings.size(); i++) { + ParameterMapping parameterMapping = parameterMappings.get(i); + if (parameterMapping.getMode() != ParameterMode.OUT) { + Object value; + String propertyName = parameterMapping.getProperty(); + if (boundSql.hasAdditionalParameter(propertyName)) { + value = boundSql.getAdditionalParameter(propertyName); + } else if (params == null) { + value = null; + } else if (typeHandlerRegistry.hasTypeHandler(params.getClass())) { + value = params; + } else { + MetaObject metaObject = configuration.newMetaObject(params); + value = metaObject.getValue(propertyName); + } + JdbcType jdbcType = parameterMapping.getJdbcType(); + if (value == null && jdbcType == null) jdbcType = configuration.getJdbcTypeForNull(); + sql = replaceParameter(sql, value, jdbcType, parameterMapping.getJavaType()); + } + } + } + return sql; + } + + /** + * 根据类型替换参数 + * + * 仅作为数字和字符串两种类型进行处理,需要特殊处理的可以继续完善这里 + * @param sql + * @param value + * @param jdbcType + * @param javaType + * @return + */ + private static String replaceParameter(String sql, Object value, JdbcType jdbcType, Class javaType) { + String strValue = String.valueOf(value); + if (jdbcType != null) { + switch (jdbcType) { + //数字 + + case BIT: + case TINYINT: + case SMALLINT: + case INTEGER: + case BIGINT: + case FLOAT: + case REAL: + case DOUBLE: + case NUMERIC: + case DECIMAL: + break; + //日期 + + case DATE: + case TIME: + case TIMESTAMP: + //其他,包含字符串和其他特殊类型 + + default: + strValue = "'" + strValue + "'"; + + + } + } else if (Number.class.isAssignableFrom(javaType)) { + //不加单引号 + + } else { + strValue = "'" + strValue + "'"; + } + return sql.replaceFirst("\\?", strValue); + } + + /** + * 获取指定的方法 + * @param clazz + * @param methodName + * @return + */ + private static Method getDeclaredMethods(Class clazz, String methodName) { + Method[] methods = clazz.getDeclaredMethods(); + for (Method method : methods) { + if (method.getName().equals(methodName)) { + return method; + } + } + throw new IllegalArgumentException("方法" + methodName + "不存在!"); + } + + /** + * 获取参数注解名 + * @param method + * @param i + * @param paramName + * @return + */ + private static String getParamNameFromAnnotation(Method method, int i, String paramName) { + final Object[] paramAnnos = method.getParameterAnnotations()[i]; + for (Object paramAnno : paramAnnos) { + if (paramAnno instanceof Param) { + paramName = ((Param) paramAnno).value(); + } + } + return paramName; + } + + /** + * 简单包装参数 + * @param object + * @return + */ + private static Object wrapCollection(final Object object) { + if (object instanceof List) { + Map map = new HashMap(); + map.put("list", object); + return map; + } else if (object != null && object.getClass().isArray()) { + Map map = new HashMap(); + map.put("array", object); + return map; + } + return object; + } + +} diff --git a/src/test/resources/mybatis-config.xml b/src/test/resources/mybatis-config.xml new file mode 100644 index 0000000..246e278 --- /dev/null +++ b/src/test/resources/mybatis-config.xml @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/test/resources/scripts/test_init.sql b/src/test/resources/scripts/test_init.sql new file mode 100644 index 0000000..f2a7f07 --- /dev/null +++ b/src/test/resources/scripts/test_init.sql @@ -0,0 +1,34 @@ +/* +Navicat MySQL Data Transfer + +Source Server : localhost +Source Server Version : 50617 +Source Host : localhost:3306 +Source Database : mybatis-generator-plugin + +Target Server Type : MYSQL +Target Server Version : 50617 +File Encoding : 65001 + +Date: 2017-06-26 17:30:13 +*/ + +SET FOREIGN_KEY_CHECKS=0; + +-- ---------------------------- +-- Table structure for tb +-- ---------------------------- +DROP TABLE IF EXISTS `tb`; +CREATE TABLE `tb` ( + `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '注释1', + `field1` varchar(255) DEFAULT NULL COMMENT '注释2', + PRIMARY KEY (`id`) +) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=latin1; + +-- ---------------------------- +-- Records of tb +-- ---------------------------- +INSERT INTO `tb` VALUES ('1', 'f1'); +INSERT INTO `tb` VALUES ('2', 'f2'); +INSERT INTO `tb` VALUES ('3', 'f3'); +INSERT INTO `tb` VALUES ('4', 'f4');