feat: 2.04 MyBatis *.xml SQL inspection | MyBatis *.xml SQL 实时检查

Author: LinWanCen

.idea/vcs.xml

@@ -4,14 +4,15 @@
 
 ## [1.0.0]
 
-- 2.03 add sql-list.err.md file
+- 2.04 MyBatis *.xml SQL inspection
 - 2.02 ★ Column Relationships PlantUML
 - 2.01 Copy MyBatis *.xml SQL
 - 2.00 ★ Check MyBatis *.xml SQL
 - 1.00 Export MyBatis *.xml SQL
 
 # 中文更新日志
 
+- 2.04 MyBatis *.xml SQL 实时检查
 - 2.03 增加 sql-list.err.md 文件
 - 2.02 ★ 列关系 PlantUML 图
 - 2.01 复制 MyBatis *.xml SQL

CHANGELOG.md

@@ -4,7 +4,7 @@ pluginGroup = com.github.linwancen.plugin.sql
 pluginName = sql-list
 pluginRepositoryUrl = https://github.com/LinWanCen/sql-list
 # SemVer format -> https://semver.org
-pluginVersion = 2.03
+pluginVersion = 2.04
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 201

gradle.properties

@@ -6,6 +6,7 @@
 import io.github.linwancen.sql.bean.SqlInfo;
 import io.github.linwancen.sql.bean.TableColumn;
 import io.github.linwancen.util.excel.ExcelUtils;
+import io.github.linwancen.util.format.LineFormat;
 import io.github.linwancen.util.plantuml.PlantUML;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -42,9 +43,13 @@ public SqlInfoWriter(ExcelWriter excelWriter) {
     }
 
     public void write(List<SqlInfo> sqlInfo) {
-        excelWriter.write(sqlInfo, sql);
         StringBuilder err = new StringBuilder();
         for (SqlInfo info : sqlInfo) {
+            String sqlStr = info.getSql();
+            sqlStr = LineFormat.itemsOneLine(sqlStr);
+            sqlStr = LineFormat.deleteSpaceLine(sqlStr);
+            info.setSql(sqlStr);
+
             for (TreeMap<String, TableColumn> map : info.getColumnList()) {
                 for (TableColumn v : map.values()) {
                     // column table null and one table use it
@@ -71,6 +76,7 @@ public void write(List<SqlInfo> sqlInfo) {
 
             appendErr(info, err);
         }
+        excelWriter.write(sqlInfo, sql);
 
         File file = excelWriter.writeContext().writeWorkbookHolder().getFile();
         String path = file.getAbsolutePath();

src/main/java/io/github/linwancen/sql/excel/SqlInfoWriter.java

@@ -3,7 +3,6 @@
 import io.github.linwancen.sql.bean.SqlInfo;
 import io.github.linwancen.sql.parser.jsqlparser.statement.StatementVisitor;
 import io.github.linwancen.sql.parser.log.SqlInfoLog;
-import io.github.linwancen.util.PathUtils;
 import net.sf.jsqlparser.parser.CCJSqlParser;
 import net.sf.jsqlparser.statement.Statement;
 import org.slf4j.Logger;
@@ -14,7 +13,10 @@
 
 public class JSqlParser {
     private static final Logger LOG = LoggerFactory.getLogger(JSqlParser.class);
-    public static final Pattern DELETE_PATTERN = Pattern.compile("(?i)(BINARY|(?:ur|sw)$|storageDb[\\s\\S]*)");
+    public static final Pattern DELETE_PATTERN = Pattern.compile("(?i)((?:ur|sw)$" +
+            "|BINARY" +
+            "|storageDb[\\s\\S]*" +
+            "|\n\n|\r\r|\r\n\r\n)");
 
     public static void parseSQL(SqlInfo sqlInfo) {
         parseSQL(sqlInfo, s -> DELETE_PATTERN.matcher(s).replaceAll(""));

src/main/java/io/github/linwancen/sql/parser/jsqlparser/JSqlParser.java

@@ -6,7 +6,6 @@
 import io.github.linwancen.sql.parser.mybatis.file.sql.SqlParamBuilder;
 import io.github.linwancen.sql.parser.mybatis.file.sql.XmlChange;
 import io.github.linwancen.util.PathUtils;
-import io.github.linwancen.util.format.LineFormat;
 import io.github.linwancen.util.git.GitUtils;
 import io.github.linwancen.util.xml.JdomUtils;
 import org.apache.ibatis.builder.MapperBuilderAssistant;
@@ -27,6 +26,7 @@
 
 import java.io.File;
 import java.io.FileInputStream;
+import java.io.InputStream;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -61,7 +61,7 @@ public static XmlFileParser build(Configuration configuration, File file, GitRoo
         }
     }
 
-    private XmlFileParser(FileInputStream fis, Configuration configuration, File file, GitRootInfo gitRootInfo) {
+    public XmlFileParser(InputStream fis, Configuration configuration, File file, GitRootInfo gitRootInfo) {
         this.configuration = configuration;
         this.file = file;
         if (gitRootInfo != null) {
@@ -185,8 +185,6 @@ public void parserSql(Function<SqlInfo, Boolean> fun) {
                 sql = sql.trim();
                 if (!sql.isEmpty()) {
                     sql = sql.replace("?", "''");
-                    sql = LineFormat.itemsOneLine(sql);
-                    sql = LineFormat.deleteSpaceLine(sql);
                     sqlInfo.setSql(sql);
                 }
             } catch (Exception e) {

src/main/java/io/github/linwancen/sql/parser/mybatis/file/XmlFileParser.java

@@ -11,10 +11,13 @@ import com.intellij.openapi.wm.WindowManager
 import com.intellij.util.ui.TextTransferable
 import io.github.linwancen.sql.parser.mybatis.file.XmlFileParser
 import org.apache.ibatis.session.Configuration
+import org.slf4j.LoggerFactory
 import java.io.File
+import java.nio.charset.Charset
 
 
 open class SqlCopy : CopyAction() {
+    private val log = LoggerFactory.getLogger(this::class.java)
 
     override fun update(e: AnActionEvent) {
         e.presentation.text = I18n.message("sql.copy")
@@ -25,18 +28,30 @@ open class SqlCopy : CopyAction() {
         val editor = CommonDataKeys.EDITOR.getData(dataContext) ?: return
         val project = CommonDataKeys.PROJECT.getData(dataContext) ?: return
         val virtualFile = CommonDataKeys.VIRTUAL_FILE.getData(dataContext) ?: return
+        val psiFile = CommonDataKeys.PSI_FILE.getData(dataContext) ?: return
         object : Task.Backgroundable(project, "Export SQL ") {
             override fun run(indicator: ProgressIndicator) {
+                try {
+                    runTask()
+                } catch (e: Throwable) {
+                    log.info("SqlCopy catch Throwable but log to record.", e)
+                }
+            }
+
+            private fun runTask() {
                 val file = File(virtualFile.canonicalPath ?: return)
-                val parser = XmlFileParser.build(Configuration(), file, null) ?: return
+                val inputStream = psiFile.text.byteInputStream(Charset.forName("UTF-8"))
+                val parser = XmlFileParser(inputStream, Configuration(), file, null)
+                if (parser.mapper == null) {
+                    return
+                }
                 val line = editor.caretModel.logicalPosition.line + 1
                 parser.parserSqlFragments()
                 parser.parserSql {
                     if (it.startLine <= line && line <= it.endLine) {
-                        it.sql?.let { sql ->
-                            CopyPasteManager.getInstance()?.setContents(TextTransferable(sql as CharSequence))
-                            WindowManager.getInstance()?.getStatusBar(project)?.info = "Copy SQL for ${it.fullId}"
-                        }
+                        val text = it.sql ?: it.xmlErr ?: it.sqlErr ?: return@parserSql false
+                        CopyPasteManager.getInstance()?.setContents(TextTransferable(text as CharSequence))
+                        WindowManager.getInstance()?.getStatusBar(project)?.info = "Copy SQL for ${it.fullId}"
                         false
                     } else true
                 }

src/main/kotlin/com/github/linwancen/plugin/sql/action/SqlCopy.kt

@@ -15,10 +15,12 @@ import io.github.linwancen.sql.excel.SqlInfoWriter
 import io.github.linwancen.sql.parser.AllParser
 import io.github.linwancen.util.excel.ExcelUtils
 import io.github.linwancen.util.git.GitUtils
+import org.slf4j.LoggerFactory
 import java.io.File
 
 
 open class SqlList : CopyAction() {
+    private val log = LoggerFactory.getLogger(this::class.java)
 
     override fun update(e: AnActionEvent) {
         val files = e.getData(CommonDataKeys.VIRTUAL_FILE_ARRAY) ?: return
@@ -38,6 +40,14 @@ open class SqlList : CopyAction() {
         val files = e.getData(CommonDataKeys.VIRTUAL_FILE_ARRAY) ?: return
         object : Task.Backgroundable(project, "Export SQL ") {
             override fun run(indicator: ProgressIndicator) {
+                try {
+                    runTask()
+                } catch (e: Throwable) {
+                    log.info("SqlCopy catch Throwable but log to record.", e)
+                }
+            }
+
+            private fun runTask() {
                 GitUtils.utf8()
                 if (files.isEmpty()) {
                     return

src/main/kotlin/com/github/linwancen/plugin/sql/action/SqlList.kt

@@ -0,0 +1,87 @@
+package com.github.linwancen.plugin.sql.inspection
+
+import com.intellij.codeInspection.LocalInspectionTool
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.FileViewProvider
+import com.intellij.psi.PsiElementVisitor
+import com.intellij.psi.XmlElementVisitor
+import com.intellij.psi.xml.XmlFile
+import com.intellij.psi.xml.XmlTag
+import io.github.linwancen.sql.bean.SqlInfo
+import io.github.linwancen.sql.parser.jsqlparser.JSqlParser
+import io.github.linwancen.sql.parser.mybatis.file.XmlFileParser
+import io.github.linwancen.util.format.LineColumnTip
+import org.apache.ibatis.session.Configuration
+import org.slf4j.LoggerFactory
+import java.io.File
+import java.nio.charset.Charset
+import java.util.regex.Matcher
+
+class XmlSqlInspection : LocalInspectionTool() {
+    private val log = LoggerFactory.getLogger(this::class.java)
+
+    override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
+        return object : XmlElementVisitor() {
+
+            override fun visitXmlFile(xmlFile: XmlFile?) {
+                try {
+                    visit(xmlFile)
+                } catch (e: Throwable) {
+                    log.info("XmlSqlInspection.visitXmlFile() catch Throwable but log to record.", e)
+                }
+            }
+
+            private fun visit(xmlFile: XmlFile?) {
+                val file = File(xmlFile?.virtualFile?.canonicalPath ?: return)
+                val inputStream = xmlFile.text.byteInputStream(Charset.forName("UTF-8"))
+                val parser = XmlFileParser(inputStream, Configuration(), file, null)
+                if (parser.mapper == null) {
+                    return
+                }
+
+                // build idMap
+                val idMap = mutableMapOf<String, XmlTag>()
+                val rootTags = xmlFile.rootTag?.children ?: return
+                rootTags.forEach {
+                    if (it is XmlTag) {
+                        val id = it.getAttributeValue("id") ?: return@forEach
+                        idMap[id] = it
+                    }
+                }
+
+                // parser and registerProblem
+                parser.parserSqlFragments()
+                parser.parserSql {
+                    JSqlParser.parseSQL(it)
+                    val err = it.sqlErr ?: it.xmlErr ?: return@parserSql true
+                    val xmlTag = idMap[it.id]
+                    if (xmlTag != null) {
+                        if (!registeredInChild(err, xmlFile, xmlTag, it)) {
+                            holder.registerProblem(xmlTag, "$err\n\n${it.sql ?: ""}")
+                        }
+                    }
+                    true
+                }
+            }
+
+            private fun registeredInChild(err: String, xmlFile: XmlFile, xmlTag: XmlTag, it: SqlInfo): Boolean {
+                val m: Matcher = LineColumnTip.LINE_COLUMN_PATTERN.matcher(err)
+                if (!m.find()) {
+                    return false
+                }
+                val line = m.group(1).toInt()
+                val column = m.group(2).toInt()
+                val tagStart = xmlTag.textRange?.startOffset ?: return false
+                val viewProvider: FileViewProvider = xmlFile.viewProvider
+                val document = viewProvider.document ?: return false
+                val tagLine = document.getLineNumber(tagStart)
+                val startOffset = document.getLineStartOffset(tagLine + line)
+                val psiElement = viewProvider.findElementAt(startOffset + column - 1) ?: return false
+                holder.registerProblem(psiElement, "$err\n\n${it.sql ?: ""}")
+                return true
+            }
+
+        }
+    }
+
+}

src/main/kotlin/com/github/linwancen/plugin/sql/inspection/XmlSqlInspection.kt

@@ -31,4 +31,17 @@
             <add-to-group group-id="ProjectViewPopupMenu" anchor="before" relative-to-action="CompareTwoFiles"/>
         </action>
     </actions>
+
+    <extensions defaultExtensionNs="com.intellij">
+        <localInspection language="XML"
+                         shortName="XmlSql"
+                         bundle="messages.I18n"
+                         key="inspection.xml.sql.display.name"
+                         groupPath="SqlList"
+                         groupBundle="messages.I18n"
+                         groupKey="inspection.sql.list.group.key"
+                         enabledByDefault="true"
+                         level="WARNING"
+                         implementationClass="com.github.linwancen.plugin.sql.inspection.XmlSqlInspection"/>
+    </extensions>
 </idea-plugin>

src/main/resources/META-INF/plugin.xml

@@ -0,0 +1,8 @@
+<html lang="en">
+<body>
+MyBatis.xml SQL have error or JSqlParser not Support this.<br>
+<!-- tooltip end -->
+<br>
+<br>
+</body>
+</html>

src/main/resources/inspectionDescriptions/XmlSql.html

@@ -3,3 +3,7 @@ sql.diff=Export MyBaits *.xml Diff SQL
 sql.copy=Copy MyBaits *.xml SQL
 sql.list.git=Export MyBaits *.xml SQL With Git Author. Slow!
 sql.diff.git=Export MyBaits *.xml Diff SQL With Git Author. Slow!
+
+inspection.sql.list.group.key=XmlSql
+
+inspection.xml.sql.display.name=Xml SQL Err

src/main/resources/messages/I18n.properties

@@ -3,3 +3,7 @@ sql.diff=\u5BFC\u51FA MyBaits *.xml \u5DEE\u5F02\u7684 SQL
 sql.copy=\u590D\u5236 MyBaits *.xml \u7684 SQL
 sql.list.git=\u5BFC\u51FA MyBaits *.xml \u7684 SQL \u5E26 Git \u4F5C\u8005\uFF0C\u6162\uFF01
 sql.diff.git=\u5BFC\u51FA MyBaits *.xml \u5DEE\u5F02\u7684 SQL \u5E26 Git \u4F5C\u8005\uFF0C\u6162\uFF01
+
+inspection.sql.list.group.key=XmlSql
+
+inspection.xml.sql.display.name=Xml SQL \u95EE\u9898