mybatis-generator工具生成反向实体失败问题排查

谁借莪１个温暖的怀抱￠ 2022-12-27 01:49 139阅读 0赞

以前在单体架构下常用此工具反向生成实体和mapper文件，主要配置如下：

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE generatorConfiguration
            PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
            "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
    
    <generatorConfiguration>
        
    
        <context id="generatorTables" targetRuntime="MyBatis3">
    
            
         <commentGenerator type="com.navinfo.nmp.power.service.utils.MyCommentGenerator">
            </commentGenerator>
    
        
            
            <jdbcConnection driverClass="org.postgresql.Driver"
                            connectionURL="jdbc:postgresql://10.130.16.2466:305188/power" userId="postgres"
                            password="123456">
            </jdbcConnection>
    
    
            
            <javaTypeResolver>
                <property name="forceBigDecimals" value="false" />
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="com.navinfo.nmp.power.service.pojo" targetProject="src/main/java">
                <property name="enableSubPackages" value="true" />
                <property name="trimStrings" value="true" />
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            </sqlMapGenerator>
    
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.navinfo.nmp.power.service.mapper" targetProject="src/main/java">
                <property name="enableSubPackages" value="true" />
            </javaClientGenerator>
    
            
            <table tableName="fiber" domainObjectName="Fiber"
                   enableCountByExample="false" enableUpdateByExample="false"
                   enableDeleteByExample="false" enableSelectByExample="false"
                   selectByExampleQueryId="true"></table>
    
        </context>
    </generatorConfiguration>

但是现在微服务架构下，生成失败，也没有报啥错误，我跟了一下源码发现，找不到文件主目录，忽然豁然开朗；微服务多个了一层目录结构；

1、如图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70][]

2、因此xml应 如下配置：

<sqlMapGenerator targetPackage="mapper" targetProject="power-server-impl/src/main/resources">
            </sqlMapGenerator>

3、查源码证明：核心入口

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70 1][]

4、点击  myBatisGenerator.generate(null);

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70 2][]

继续点击：

public void generate(ProgressCallback callback, Set<String> contextIds,
                Set<String> fullyQualifiedTableNames) throws SQLException,
                IOException, InterruptedException {
    
            if (callback == null) {
                callback = new NullProgressCallback();
            }
    
            generatedJavaFiles.clear();
            generatedXmlFiles.clear();
    
            // calculate the contexts to run
            List<Context> contextsToRun;
            if (contextIds == null || contextIds.size() == 0) {
                contextsToRun = configuration.getContexts();
            } else {
                contextsToRun = new ArrayList<Context>();
                for (Context context : configuration.getContexts()) {
                    if (contextIds.contains(context.getId())) {
                        contextsToRun.add(context);
                    }
                }
            }
    
            // setup custom classloader if required
            if (configuration.getClassPathEntries().size() > 0) {
                ClassLoader classLoader = getCustomClassloader(configuration.getClassPathEntries());
                ObjectFactory.addExternalClassLoader(classLoader);
            }
    
            // now run the introspections...
            int totalSteps = 0;
            for (Context context : contextsToRun) {
                totalSteps += context.getIntrospectionSteps();
            }
            callback.introspectionStarted(totalSteps);
    
            for (Context context : contextsToRun) {
                context.introspectTables(callback, warnings,
                        fullyQualifiedTableNames);
            }
    
            // now run the generates
            totalSteps = 0;
            for (Context context : contextsToRun) {
                totalSteps += context.getGenerationSteps();
            }
            callback.generationStarted(totalSteps);
    
            for (Context context : contextsToRun) {
                context.generateFiles(callback, generatedJavaFiles,
                        generatedXmlFiles, warnings);
            }
    
            // now save the files
            callback.saveStarted(generatedXmlFiles.size()
                    + generatedJavaFiles.size());
            //mapper文件封装生成
            for (GeneratedXmlFile gxf : generatedXmlFiles) {
                projects.add(gxf.getTargetProject());
    
                File targetFile;
                String source;
                try {
                    //查找项目目录核心逻辑，点击进入
                    File directory = shellCallback.getDirectory(gxf
                            .getTargetProject(), gxf.getTargetPackage());
                    targetFile = new File(directory, gxf.getFileName());
                    if (targetFile.exists()) {
                        if (gxf.isMergeable()) {
                            source = XmlFileMergerJaxp.getMergedSource(gxf,
                                    targetFile);
                        } else if (shellCallback.isOverwriteEnabled()) {
                            source = gxf.getFormattedContent();
                            warnings.add(getString("Warning.11", //$NON-NLS-1$
                                    targetFile.getAbsolutePath()));
                        } else {
                            source = gxf.getFormattedContent();
                            targetFile = getUniqueFileName(directory, gxf
                                    .getFileName());
                            warnings.add(getString(
                                    "Warning.2", targetFile.getAbsolutePath())); //$NON-NLS-1$
                        }
                    } else {
                        source = gxf.getFormattedContent();
                    }
                } catch (ShellException e) {
                    warnings.add(e.getMessage());
                    continue;
                }
    
                callback.checkCancel();
                callback.startTask(getString(
                        "Progress.15", targetFile.getName())); //$NON-NLS-1$
                writeFile(targetFile, source, "UTF-8"); //$NON-NLS-1$
            }
            //接口和实体类文件封装生成
            for (GeneratedJavaFile gjf : generatedJavaFiles) {
                projects.add(gjf.getTargetProject());
    
                File targetFile;
                String source;
                try {
                    File directory = shellCallback.getDirectory(gjf
                            .getTargetProject(), gjf.getTargetPackage());
                    targetFile = new File(directory, gjf.getFileName());
                    if (targetFile.exists()) {
                        if (shellCallback.isMergeSupported()) {
                            source = shellCallback.mergeJavaFile(gjf
                                    .getFormattedContent(), targetFile
                                    .getAbsolutePath(),
                                    MergeConstants.OLD_ELEMENT_TAGS,
                                    gjf.getFileEncoding());
                        } else if (shellCallback.isOverwriteEnabled()) {
                            source = gjf.getFormattedContent();
                            warnings.add(getString("Warning.11", //$NON-NLS-1$
                                    targetFile.getAbsolutePath()));
                        } else {
                            source = gjf.getFormattedContent();
                            targetFile = getUniqueFileName(directory, gjf
                                    .getFileName());
                            warnings.add(getString(
                                    "Warning.2", targetFile.getAbsolutePath())); //$NON-NLS-1$
                        }
                    } else {
                        source = gjf.getFormattedContent();
                    }
    
                    callback.checkCancel();
                    callback.startTask(getString(
                            "Progress.15", targetFile.getName())); //$NON-NLS-1$
                    writeFile(targetFile, source, gjf.getFileEncoding());
                } catch (ShellException e) {
                    warnings.add(e.getMessage());
                }
            }
    
            for (String project : projects) {
                shellCallback.refreshProject(project);
            }
    
            callback.done();
        }

5、进入这个方法 shellCallback.getDirectory

public File getDirectory(String targetProject, String targetPackage)
                throws ShellException {
            // targetProject is interpreted as a directory that must exist
            //
            // targetPackage is interpreted as a sub directory, but in package
            // format (with dots instead of slashes). The sub directory will be
            // created
            // if it does not already exist
            //此处核对查找文件所放目录
            File project = new File(targetProject);
            if (!project.isDirectory()) {//如果没有，直接抛出异常
                throw new ShellException(getString("Warning.9", //$NON-NLS-1$
                        targetProject));
            }
    
            StringBuilder sb = new StringBuilder();
            StringTokenizer st = new StringTokenizer(targetPackage, "."); //$NON-NLS-1$
            while (st.hasMoreTokens()) {
                sb.append(st.nextToken());
                sb.append(File.separatorChar);
            }
    
            File directory = new File(project, sb.toString());
            if (!directory.isDirectory()) {
                boolean rc = directory.mkdirs();
                if (!rc) {
                    throw new ShellException(getString("Warning.10", //$NON-NLS-1$
                            directory.getAbsolutePath()));
                }
            }
    
            return directory;
        }

6、dubug演示一下：没找到此目录抛出异常

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70 3][]

7、修改参数 targetProject="power-service-impl/src/main/resources" 正常后演示

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70 4][]

到此完成分享。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70]: /images/20221120/5ddec9a8cb194523a053632bbe67fcef.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201207133430679.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201207133533565.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20201207134232552.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20201207134500554.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmRhbzE1OA==,size_16,color_FFFFFF,t_70