✨ feat: *-translate.xml enhance

CHANGELOG.md

@@ -4,6 +4,22 @@
 
 ## [Unreleased]
 
+### Added
+- Support cache translation reference redirection
+- Added language injections: 'SQLToy SQL ID' and 'SQLToy TRANSLATE ID'
+- 支持`*-translate.xml`文件的缓存定义跳转至java代码`lightDao.getTranslateCache`、`new CacheMatchFilter().cacheName("dictKeyName")`、`new Translate("dictKeyName")`
+- 支持`*-translate.xml`文件内部`Checker`属性的`cache`值跳转到缓存定义。`<sql-increment-checker cache="dictKeyName">`、`<sql-translate
+  cache="dictKeyName">`
+- 支持`*.sql.xml`文件`sql`定义中`cache`值跳转到缓存定义.`<sql id="sys_findStaffInfo"><translate cache="dictKeyName" columns="DICT_KEY" /></sql>`
+- 以上所有xml中的`cache`属性,java中的`cacheName`均支持自动完成、自动提示
+- `sqlId`、`cacheName`的引用均增加了下划线高亮.
+- 增加了`SQLToy SQL ID`、`SQLToy TRANSLATE ID`两个语言注入，可以在任意字符串位置将某个字符串注入为`sqlId`或`cacheName`，注入后效果一致
+
+### Changed
+- Refactoring indexes while supporting SQLId and cache translation
+- 重构了文件索引以同时支持`sqlId`和缓存翻译
+- 优化部分代码匹配机制，提高性能及内存消耗
+
 ## [0.4.3] - 2024-05-28
 
 ### Added

build.gradle.kts

@@ -19,9 +19,9 @@ version = properties("pluginVersion").get()
 // Configure project's dependencies
 repositories {
     mavenLocal()
-    maven {
+    /*maven {
         url = uri("https://maven.aliyun.com/repository/public")
-    }
+    }*/
     mavenCentral()
 }
 

gradle.properties

@@ -4,7 +4,7 @@ pluginGroup = com.github.imyuyu
 pluginName = SQLToy Integration
 pluginRepositoryUrl = https://github.com/imyuyu/sqltoy-idea-plugin
 # SemVer format -> https://semver.org
-pluginVersion = 0.4.3
+pluginVersion = 0.5.0
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 222

src/main/kotlin/com/github/imyuyu/sqltoy/SQLToyFindUsagesHandlerFactory.kt

@@ -0,0 +1,28 @@
+package com.github.imyuyu.sqltoy
+
+import com.github.imyuyu.sqltoy.model.highlighting.jam.SQLToyTranslateFindUsagesHandler
+import com.github.imyuyu.sqltoy.util.XmlUtil
+import com.intellij.find.findUsages.FindUsagesHandler
+import com.intellij.find.findUsages.FindUsagesHandlerFactory
+import com.intellij.openapi.module.ModuleUtilCore
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiFile
+
+class SQLToyFindUsagesHandlerFactory: FindUsagesHandlerFactory() {
+
+    override fun canFindUsages(element: PsiElement): Boolean {
+        val module = ModuleUtilCore.findModuleForPsiElement(element);
+        val containingFile: VirtualFile = element.containingFile.virtualFile
+        return XmlUtil.isSqltoyXml(containingFile);
+    }
+
+    override fun createFindUsagesHandler(element: PsiElement, forHighlightUsages: Boolean): FindUsagesHandler? {
+        if(XmlUtil.isTranslateXml(element)){
+            //
+            return SQLToyTranslateFindUsagesHandler(element, forHighlightUsages);
+        } else {
+            return null;
+        }
+    }
+}

src/main/kotlin/com/github/imyuyu/sqltoy/action/MainActionGroup.kt

@@ -0,0 +1,47 @@
+package com.github.imyuyu.sqltoy.action
+
+import com.intellij.database.psi.DbTable
+import com.intellij.openapi.actionSystem.AnAction
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.LangDataKeys
+import com.intellij.openapi.project.Project
+
+
+/**
+ * create java code
+ */
+class MainActionGroup : AnAction() {
+
+    override fun actionPerformed(event: AnActionEvent) {
+        val project: Project = event.getProject() ?: return
+
+        //获取选中的PSI元素
+        val psiElement = event.getData(LangDataKeys.PSI_ELEMENT)
+        var selectDbTable: DbTable? = null
+        if (psiElement is DbTable) {
+            selectDbTable = psiElement
+        }
+        if (selectDbTable == null) {
+            return;
+        }
+
+        //获取选中的所有表
+        val psiElements = event.getData(LangDataKeys.PSI_ELEMENT_ARRAY)
+        if (psiElements.isNullOrEmpty()) {
+            return;
+        }
+
+        val dbTableList: MutableList<DbTable> = ArrayList()
+        for (element in psiElements) {
+            if (element !is DbTable) {
+                continue
+            }
+            dbTableList.add(element)
+        }
+        if (dbTableList.isEmpty()) {
+            return;
+        }
+
+        // 弹出form处理
+    }
+}

src/main/kotlin/com/github/imyuyu/sqltoy/dom/model/Sql.kt

@@ -1,5 +1,6 @@
 package com.github.imyuyu.sqltoy.dom.model
 
+import com.github.imyuyu.sqltoy.dom.model.converters.SQLToySqlIdConverter
 import com.intellij.util.xml.*
 import org.jetbrains.annotations.NotNull
 
@@ -15,7 +16,8 @@ interface Sql : DomElement {
      *
      * @return the id
      */
-    @Required
+    @Referencing(value = SQLToySqlIdConverter::class, soft = true)
+    @Required(identifier = true)
     @NameValue
     @Attribute("id")
     fun getId(): GenericAttributeValue<String>
@@ -42,4 +44,7 @@ interface Sql : DomElement {
 
     @SubTag("page-optimize")
     fun getPageOptimize() : PageOptimize
+
+    @SubTagList("translate")
+    fun getTranslate(): List<TranslateConfig>
 }

src/main/kotlin/com/github/imyuyu/sqltoy/dom/model/TranslateConfig.kt

@@ -0,0 +1,37 @@
+package com.github.imyuyu.sqltoy.dom.model
+
+import com.github.imyuyu.sqltoy.dom.model.converters.SQLToyTranslateConverter
+import com.intellij.util.xml.*
+
+/**
+ * The interface translate element.
+ */
+interface TranslateConfig:DomElement{
+
+    @Referencing(SQLToyTranslateConverter::class)
+    @Required
+    @Attribute("cache")
+    fun getCache() : GenericAttributeValue<String>
+
+    @Required
+    @Attribute("cache")
+    fun getColumns():GenericAttributeValue<String>
+
+    @Attribute("cache-type")
+    fun getCacheType() : GenericAttributeValue<String>
+
+    @Attribute("split-regex")
+    fun getSplitRegex() : GenericAttributeValue<String>
+
+    @Attribute("link-sign")
+    fun getLinkSign() : GenericAttributeValue<String>
+
+    @Attribute("cache-indexs")
+    fun getCacheIndexs() : GenericAttributeValue<String>
+
+    @Attribute("uncached-template")
+    fun getUncachedTemplate() : GenericAttributeValue<String>
+
+    @Attribute("original-columns")
+    fun getOriginalColumns() : GenericAttributeValue<String>
+}

src/main/kotlin/com/github/imyuyu/sqltoy/dom/model/converters/SQLToySqlIdConverter.kt

@@ -0,0 +1,5 @@
+package com.github.imyuyu.sqltoy.dom.model.converters
+
+import com.intellij.util.xml.CustomReferenceConverter
+
+abstract class SQLToySqlIdConverter : CustomReferenceConverter<String?>

src/main/kotlin/com/github/imyuyu/sqltoy/dom/model/converters/SQLToySqlIdConverterImpl.kt

@@ -0,0 +1,50 @@
+package com.github.imyuyu.sqltoy.dom.model.converters
+
+import com.github.imyuyu.sqltoy.dom.model.Sql
+import com.intellij.pom.PomTargetPsiElement
+import com.intellij.pom.references.PomService
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiReference
+import com.intellij.psi.PsiReferenceBase
+import com.intellij.psi.ResolvingHint
+import com.intellij.spring.model.BeanService
+import com.intellij.util.ReflectionUtil
+import com.intellij.util.xml.ConvertContext
+import com.intellij.util.xml.DomTarget
+import com.intellij.util.xml.GenericDomValue
+
+class SQLToySqlIdConverterImpl : SQLToySqlIdConverter() {
+
+    override fun createReferences(
+        value: GenericDomValue<String?>?,
+        element: PsiElement,
+        context: ConvertContext?
+    ): Array<PsiReference> {
+        return arrayOf<PsiReference>(SQLIdReference(element, value));
+    }
+
+    class SQLIdReference(element:PsiElement, genericDomValue:GenericDomValue<String?>?): PsiReferenceBase<PsiElement>(element, true), ResolvingHint  {
+
+        private val myGenericDomValue = genericDomValue;
+
+        override fun resolve(): PsiElement? {
+            val sql = getSQLIdBean();
+            if(sql == null){
+                return null;
+            }
+            val target = DomTarget.getTarget(sql);
+            return PomService.convertToPsi(target!!);
+        }
+
+        override fun canResolveTo(elementClass: Class<out PsiElement>?): Boolean {
+            return ReflectionUtil.isAssignable(
+                PomTargetPsiElement::class.java,
+                elementClass!!
+            )
+        }
+
+        private fun getSQLIdBean(): Sql? {
+            return myGenericDomValue?.getParentOfType<Sql>(Sql::class.java, false)
+        }
+    }
+}

src/main/kotlin/com/github/imyuyu/sqltoy/dom/model/converters/SQLToyTranslateConverter.kt

@@ -0,0 +1,5 @@
+package com.github.imyuyu.sqltoy.dom.model.converters
+
+import com.intellij.util.xml.CustomReferenceConverter
+
+abstract class SQLToyTranslateConverter : CustomReferenceConverter<String?>

src/main/kotlin/com/github/imyuyu/sqltoy/dom/model/converters/SQLToyTranslateConverterImpl.kt

@@ -0,0 +1,103 @@
+package com.github.imyuyu.sqltoy.dom.model.converters
+
+import com.github.imyuyu.sqltoy.dom.model.TranslateConfig
+import com.github.imyuyu.sqltoy.dom.model.translate.Checker
+import com.github.imyuyu.sqltoy.indexer.SQLIdIndexHolder
+import com.github.imyuyu.sqltoy.indexer.SQLToyBeanIndexType
+import com.github.imyuyu.sqltoy.ui.Icons
+import com.github.imyuyu.sqltoy.util.SearchUtil
+import com.intellij.codeInsight.daemon.EmptyResolveMessageProvider
+import com.intellij.codeInsight.highlighting.HighlightedReference
+import com.intellij.codeInsight.lookup.LookupElementBuilder
+import com.intellij.pom.PomTargetPsiElement
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiReference
+import com.intellij.psi.PsiReferenceBase
+import com.intellij.psi.ResolvingHint
+import com.intellij.psi.search.GlobalSearchScope
+import com.intellij.util.ReflectionUtil
+import com.intellij.util.xml.ConvertContext
+import com.intellij.util.xml.GenericDomValue
+
+class SQLToyTranslateConverterImpl : SQLToyTranslateConverter() {
+
+    override fun createReferences(
+        value: GenericDomValue<String?>?,
+        element: PsiElement,
+        context: ConvertContext?
+    ): Array<PsiReference> {
+        return arrayOf<PsiReference>(SQLToyTranslateReference(element, value));
+    }
+
+    class SQLToyTranslateReference(element:PsiElement, genericDomValue:GenericDomValue<String?>?): PsiReferenceBase<PsiElement>(element, true), ResolvingHint, HighlightedReference,
+        EmptyResolveMessageProvider {
+
+        private val myGenericDomValue = genericDomValue;
+
+        override fun resolve(): PsiElement? {
+            var cacheName: String? = null;
+            val checker = getTranslateCheckerBean();
+            if(checker != null){
+                //
+                cacheName = checker.getCache().toString();
+            }
+
+            if(cacheName == null){
+                val translateConfigBean = getTranslateConfigBean()
+                if (translateConfigBean != null) {
+                    cacheName = translateConfigBean.getCache().toString();
+                }
+            }
+
+            if(cacheName == null){
+                return null;
+            }
+
+            SQLIdIndexHolder.findRecordsByQualifiedId(SQLToyBeanIndexType.TRANSLATE_ID, cacheName, element.project, SearchUtil.getSearchScope(element.project, element))
+                .forEach { record ->
+                    record.getElements(element.project)
+                        .forEach {
+                            return it;
+                        }
+                }
+
+            return null;
+            /*val target = DomTarget.getTarget(sql);
+            return PomService.convertToPsi(target!!);*/
+        }
+
+        override fun getVariants(): Array<Any> {
+            val allIds = SQLIdIndexHolder.getAllTranslateIds(element.project, GlobalSearchScope.projectScope(element.project))
+            return allIds.map {
+                LookupElementBuilder.create(it).withIcon(Icons.XML_ICON);
+            }.toTypedArray();
+        }
+
+        private fun getTranslateConfigBean(): TranslateConfig? {
+            return myGenericDomValue?.getParentOfType(TranslateConfig::class.java, false)
+        }
+
+        override fun canResolveTo(elementClass: Class<out PsiElement>?): Boolean {
+            return ReflectionUtil.isAssignable(
+                PomTargetPsiElement::class.java,
+                elementClass!!
+            )
+        }
+
+        private fun getTranslateCheckerBean(): Checker? {
+            return myGenericDomValue?.getParentOfType(Checker::class.java, false)
+        }
+
+        override fun getUnresolvedMessagePattern(): String {
+            return "Cannot resolve translate '${value}'"
+        }
+
+        override fun bindToElement(element: PsiElement): PsiElement {
+            return getElement()
+        }
+
+        override fun isHighlightedWhenSoft(): Boolean {
+            return true
+        }
+    }
+}

src/main/kotlin/com/github/imyuyu/sqltoy/dom/model/translate/CacheTranslate.kt

@@ -15,10 +15,10 @@ interface CacheTranslate : DomElement {
     fun getSqlTranslate() : List<SqlTranslate>
 
     @SubTagList("service-translate")
-    fun getRestTranslate() : List<RestTranslate>
+    fun getRestTranslate() : List<ServiceTranslate>
 
     @SubTagList("rest-translate")
-    fun getServiceTranslate() : List<ServiceTranslate>
+    fun getServiceTranslate() : List<RestTranslate>
 
     @SubTagsList("sql-translate", "service-translate", "rest-translate")
     fun getAllTranslate() : List<Translate>

src/main/kotlin/com/github/imyuyu/sqltoy/dom/model/translate/Checker.kt

@@ -1,19 +1,22 @@
 package com.github.imyuyu.sqltoy.dom.model.translate
 
 import com.github.imyuyu.sqltoy.dom.model.ValueElement
+import com.github.imyuyu.sqltoy.dom.model.converters.SQLToyTranslateConverter
 import com.intellij.util.xml.Attribute
 import com.intellij.util.xml.DomElement
 import com.intellij.util.xml.GenericAttributeValue
+import com.intellij.util.xml.Referencing
 import com.intellij.util.xml.Required
 
 /**
  * Checker interface
  */
 interface Checker : DomElement {
 
+    @Referencing(SQLToyTranslateConverter::class)
     @Required
     @Attribute("cache")
-    fun getCache() : ValueElement
+    fun getCache() : GenericAttributeValue<String>
 
     @Attribute("check-frequency")
     fun getCheckFrequency() : GenericAttributeValue<Int>