v1.1.0, SpEL Template Support

Author: ly-chn

README.md

@@ -20,4 +20,35 @@
 
 ### 配置详解
 
-![demo](./doc/img/json.png)
+```json5
+{
+   // 注解声明, 格式为`注解类@字段`
+   "kim.nzxy.demo.DemoAop@value": {
+      // 模板前缀, 为null和空字符串表示非模板, 默认为空
+      "prefix": "#{",
+      // 模板后缀, 为null和空字符串表示非模板, 默认为空
+      "suffix": "}",
+      // 对方法的扩展, 默认值如示例
+      "method": {
+         // 作用于方法上时, 支持方法返回值提示
+         "result": false,
+         // 方法返回值的SpEL变量名
+         "resultName": "result",
+         // 作用于方法上时, 支持方法参数提示
+         "parameters": false,
+         // 方法参数别名配置, 支持多个别名前缀, 如 [p0, a1, p2]分表表示第一个, 第二个, 第三个参数, 可空 
+         "parametersPrefix": [
+            "p",
+            "a"
+         ]
+      },
+      // 自定义字段, 默认为空
+      "fields": {
+         // 自定义变量以及类型, 支持非限定类名, 如String, Integer等, 否则需提供全限定类名
+         "demo": "java.util.Map<String, String>",
+         // 如果变量名为root, 则表示rootObject(可以直接)
+         "root": "kim.nzxy.demo.DemoRoot"
+      }
+   }
+}
+```

build.gradle.kts

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = "kim.nzxy"
-version = "1.0.1"
+version = "1.1.0"
 
 tasks {
     buildSearchableOptions{

doc/img/json.png

@@ -19,7 +19,8 @@ class LySpELExtensionLanguageInject : LanguageInjectionContributor {
 
         val service = SpELConfigService.getInstance()
         val path = service.getFieldPath(context) ?: return null
-        if (service.hasSpELInfo(context.project, "${path.first}@${path.second}")) {
+        val spELInfo = service.getSpELInfo(context.project, "${path.first}@${path.second}") ?: return null
+        if (LyUtil.isEmpty(spELInfo.prefix) && LyUtil.isEmpty(spELInfo.suffix)) {
             return injection
         }
         return null

src/main/kotlin/kim/nzxy/spel/LySpELExtensionLanguageInject.kt

@@ -0,0 +1,50 @@
+package kim.nzxy.spel
+
+import com.intellij.lang.injection.MultiHostInjector
+import com.intellij.lang.injection.MultiHostRegistrar
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiLanguageInjectionHost
+import com.intellij.psi.PsiLiteralExpression
+import com.intellij.spring.el.SpringELLanguage
+import org.jetbrains.kotlin.psi.KtStringTemplateExpression
+
+
+class LySpELLanguageMultiHostInjector : MultiHostInjector {
+    override fun getLanguagesToInject(registrar: MultiHostRegistrar, context: PsiElement) {
+        val service = SpELConfigService.getInstance()
+        val path = service.getFieldPath(context) ?: return
+        val spELInfo = service.getSpELInfo(context.project, "${path.first}@${path.second}") ?: return
+        if (LyUtil.isEmpty(spELInfo.prefix) || LyUtil.isEmpty(spELInfo.suffix)) {
+            return
+        }
+        registrar.startInjecting(SpringELLanguage.INSTANCE)
+        val text = context.text
+        val prefix = spELInfo.prefix!!
+        val suffix = spELInfo.suffix!!
+        var index = 0
+        while (true) {
+            val start = text.indexOf(prefix, index)
+            if (start == -1) {
+                break
+            }
+            val end = text.indexOf(suffix, start + prefix.length)
+            if (end == -1) {
+                break
+            }
+            registrar.addPlace(null, null, context as PsiLanguageInjectionHost, TextRange(start + prefix.length, end))
+            println(context.text)
+            println(context.textRange)
+            index = end + suffix.length
+        }
+        registrar.doneInjecting()
+    }
+
+    override fun elementsToInjectIn(): MutableList<out Class<out PsiElement>> {
+        val result: MutableList<Class<out PsiElement>> = mutableListOf(PsiLiteralExpression::class.java)
+        if (PluginChecker.getInstance().kotlin()) {
+            result.add(KtStringTemplateExpression::class.java)
+        }
+        return result
+    }
+}

src/main/kotlin/kim/nzxy/spel/LySpELLanguageMultiHostInjector.kt

@@ -0,0 +1,11 @@
+package kim.nzxy.spel
+
+object LyUtil {
+    /**
+     * 判空
+     */
+    fun isEmpty(str: String?): Boolean{
+        str ?: return true
+        return str.isEmpty()
+    }
+}

src/main/kotlin/kim/nzxy/spel/LyUtil.kt

@@ -9,7 +9,9 @@ import com.intellij.psi.PsiFile
 data class SpELInfo(
     var method: SpELInfoMethod? = SpELInfoMethod(),
     var fields: HashMap<String, String>? = hashMapOf(),
-    var sourceFile: PsiFile?
+    var sourceFile: PsiFile?,
+    var prefix: String?,
+    var suffix: String?
 )
 
 data class SpELInfoMethod(

src/main/kotlin/kim/nzxy/spel/json/SpELInfo.kt

@@ -75,7 +75,7 @@ class SpELJsonCompletionContributor : CompletionContributor() {
             val quoted = if (hasBody) {
                 "\"${item.lookupString}\""
             } else {
-                """"${item.lookupString}": {"method": {"result": false,"resultName": "result","parameters": false,
+                """"${item.lookupString}": {"prefix": "", "suffix": "", "method": {"result": false,"resultName": "result","parameters": false,
                     "parametersPrefix": ["p", "a"],},"fields": {"demo": "java.util.Map<String, String>"}},"""
             }
             val endOffSet = if (hasBody || hasQuote) range.endOffset else range.startOffset + item.lookupString.length

src/main/kotlin/kim/nzxy/spel/json/SpELJsonCompletionContributor.kt

@@ -27,6 +27,8 @@
         <spring.el.contexts implementation="kim.nzxy.spel.LySpringElContextsExtension" order="first" id="SpEL-ly-chn"/>
         <languageInjectionContributor implementationClass="kim.nzxy.spel.LySpELExtensionLanguageInject"
                                       order="first" language="UAST"/>
+        <multiHostInjector implementationClass="kim.nzxy.spel.LySpELLanguageMultiHostInjector"
+                                      order="first" language="UAST"/>
         <localInspection language="JSON" shortName="SpELJsonKey"
                          displayName="SpEL JSON Inspection"
                          groupName="SpEL assistant"

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

@@ -71,5 +71,15 @@
       }
     }
   },
+  "properties": {
+    "prefix": {
+      "type": "string",
+      "description": "Defines SpEL template prefix"
+    },
+    "suffix": {
+      "type": "string",
+      "description": "Defines SpEL template suffix"
+    }
+  },
   "additionalProperties": false
 }