修复插件BUG:

bigcoder84 · bigcoder84 · commit d97ed8b0b391 · 2021-02-08T22:55:58.000+08:00
1.修复GenerateO2O组件不能生成父类中字段代码的问题
2.优化插件使用体验
diff --git a/README.md b/README.md
@@ -1,4 +1,8 @@
 # object-helper-plugin
+![](https://img.shields.io/badge/version-v1.0.2-blue)
+![](https://img.shields.io/badge/license-Apache%202-red)
+![](https://img.shields.io/badge/download-100%2B-green)
+
 JetBrains Intellij IDEA Obejct辅助插件，包含以下功能：
 
 - 对象拷贝
diff --git a/object-helper.jar b/object-helper.jar
diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -1,7 +1,7 @@
 <idea-plugin>
   <id>cn.bigcoder.plugin.objecthelper</id>
   <name>ObjectHelper</name>
-  <version>1.0.2</version>
+  <version>1.0.3</version>
   <vendor email="bigcoder84@gmail.com" url="https://github.com/tianjindong/object-helper-plugin">HearingSmile</vendor>
 
   <description><![CDATA[
@@ -11,8 +11,7 @@
     ]]></description>
 
   <change-notes><![CDATA[
-      <li>Fix bug：Fixed location visibility of GenerateO2O components outside of methods</li>
-      <li>Add logo</li>
+      <li>Fix bug：Fixed parent field not being generated</li>
     ]]>
   </change-notes>
 
@@ -29,7 +28,7 @@
   </extensions>
 
   <actions>
-    <action id="ObjectHelper" class="cn.bigcoder.plugin.objecthelper.component.GenerateO2O" text="GenerateO2O">
+    <action id="cn.bigcoder.plugin.objecthelper.action.GenerateO2O" class="cn.bigcoder.plugin.objecthelper.action.GenerateO2O" text="GenerateO2O">
       <add-to-group group-id="GenerateGroup" anchor="last"/>
     </action>
   </actions>
diff --git a/src/cn/bigcoder/plugin/objecthelper/action/GenerateO2O.java b/src/cn/bigcoder/plugin/objecthelper/action/GenerateO2O.java
@@ -1,32 +1,33 @@
-package cn.bigcoder.plugin.objecthelper.component;
+package cn.bigcoder.plugin.objecthelper.action;
 
 import cn.bigcoder.plugin.objecthelper.common.util.PsiUtils;
+import cn.bigcoder.plugin.objecthelper.common.util.StringUtils;
 import cn.bigcoder.plugin.objecthelper.generator.Generator;
 import cn.bigcoder.plugin.objecthelper.generator.method.ObjectCopyMethodGenerator;
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.command.WriteCommandAction;
 import com.intellij.psi.JavaPsiFacade;
-import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiElementFactory;
 import com.intellij.psi.PsiMethod;
-import com.intellij.psi.util.PsiTreeUtil;
 import org.jetbrains.annotations.NotNull;
 
+import static cn.bigcoder.plugin.objecthelper.common.constant.JavaKeyWord.*;
+
 public class GenerateO2O extends AnAction {
 
     @Override
     public void actionPerformed(AnActionEvent anActionEvent) {
         WriteCommandAction.runWriteCommandAction(anActionEvent.getProject(), () -> {
-            generateO2O(getPsiMethodFromContext(anActionEvent));
+            generateO2O(PsiUtils.getCursorPsiMethod(anActionEvent));
         });
     }
 
     @Override
     public void update(@NotNull AnActionEvent anActionEvent) {
         // 如果当前光标不在方法中，则不显示GernerateO2O组件
-        if (getPsiMethodFromContext(anActionEvent) == null) {
-            anActionEvent.getPresentation().setEnabled(false);
+        if (!check(PsiUtils.getCursorPsiMethod(anActionEvent))) {
+            PsiUtils.setActionDisabled(anActionEvent);
         }
         super.update(anActionEvent);
     }
@@ -37,17 +38,31 @@ private void generateO2O(PsiMethod psiMethod) {
         }
         // 初始化生成器
         Generator generator = ObjectCopyMethodGenerator.getInstance(psiMethod);
+        String methodCode = generator.generate();
+        if (StringUtils.isEmpty(methodCode)) {
+            return;
+        }
         PsiElementFactory elementFactory = JavaPsiFacade.getElementFactory(psiMethod.getProject());
         // 生成新的PsiMethod
         PsiMethod toMethod = elementFactory.createMethodFromText(generator.generate(), psiMethod);
         psiMethod.replace(toMethod);
     }
 
-    private PsiMethod getPsiMethodFromContext(AnActionEvent e) {
-        PsiElement elementAt = PsiUtils.getCursorPsiElement(e);
-        if (elementAt == null) {
-            return null;
+    /**
+     * 检查当前光标
+     * 1. 是否在方法中
+     * 2. 方法是否有入参
+     * 3. 方法是否有返回值
+     *
+     * @param psiMethod
+     * @return
+     */
+    private boolean check(PsiMethod psiMethod) {
+        if (psiMethod == null
+                || PsiUtils.getPsiParameters(psiMethod).size() == 0
+                || VOID.equals(PsiUtils.getMethodReturnClassName(psiMethod))) {
+            return false;
         }
-        return PsiTreeUtil.getParentOfType(elementAt, PsiMethod.class);
+        return true;
     }
 }
diff --git a/src/cn/bigcoder/plugin/objecthelper/common/constant/JavaKeyWord.java b/src/cn/bigcoder/plugin/objecthelper/common/constant/JavaKeyWord.java
@@ -4,7 +4,7 @@
  * @author: Jindong.Tian
  * @date: 2021-01-31
  **/
-public class JavaSeparator {
+public class JavaKeyWord {
     public static final String EMPTY_BODY = "";
     public static final String BLANK_SEPARATOR = " ";
     public static final String LINE_SEPARATOR = "\n";
diff --git a/src/cn/bigcoder/plugin/objecthelper/common/util/PsiUtils.java b/src/cn/bigcoder/plugin/objecthelper/common/util/PsiUtils.java
@@ -1,6 +1,6 @@
 package cn.bigcoder.plugin.objecthelper.common.util;
 
-import cn.bigcoder.plugin.objecthelper.common.constant.JavaSeparator;
+import cn.bigcoder.plugin.objecthelper.common.constant.JavaKeyWord;
 import cn.bigcoder.plugin.objecthelper.common.enums.JavaModify;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.actionSystem.LangDataKeys;
@@ -9,6 +9,8 @@
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.*;
 import com.intellij.psi.search.GlobalSearchScope;
+import com.intellij.psi.util.PsiTreeUtil;
+import org.apache.commons.compress.utils.Lists;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
@@ -21,8 +23,22 @@
  **/
 public class PsiUtils {
 
+    /**
+     * 获取光标处上下文的{@code PsiMethod}
+     * @param actionEvent
+     * @return
+     */
+    public static PsiMethod getCursorPsiMethod(AnActionEvent actionEvent) {
+        PsiElement elementAt = PsiUtils.getCursorPsiElement(actionEvent);
+        if (elementAt == null) {
+            return null;
+        }
+        return PsiTreeUtil.getParentOfType(elementAt, PsiMethod.class);
+    }
+
     /**
      * 获取光标所在处的{@code PsiElement}
+     *
      * @param anActionEvent
      * @return
      */
@@ -38,6 +54,14 @@ public static PsiElement getCursorPsiElement(AnActionEvent anActionEvent) {
         return psiFile.findElementAt(offset);
     }
 
+    /**
+     * 设置当前组件不可用（不显示）
+     * @param anActionEvent
+     */
+    public static void setActionDisabled(AnActionEvent anActionEvent){
+        anActionEvent.getPresentation().setEnabled(false);
+    }
+
     /**
      * 根据{@code PsiType}获取对应的{@code PsiClass}
      *
@@ -58,6 +82,7 @@ public static PsiClass getPsiClass(PsiType psiType, Project project) {
 
     /**
      * 获取方法名称
+     *
      * @param psiMethod
      * @return
      */
@@ -70,25 +95,27 @@ public static String getMethodName(PsiMethod psiMethod) {
 
     /**
      * 获取方法返回名称
+     *
      * @param psiMethod
      * @return
      */
     @NotNull
     public static String getMethodReturnClassName(PsiMethod psiMethod) {
         PsiType returnType = psiMethod.getReturnType();
         if (returnType == null) {
-            return JavaSeparator.VOID;
+            return JavaKeyWord.VOID;
         }
         return returnType.getPresentableText();
     }
 
     /**
      * 获取方法的参数列表
+     *
      * @param psiMethod
      * @return
      */
     @NotNull
-    public static List<PsiParameter> getPsiParameters(PsiMethod psiMethod){
+    public static List<PsiParameter> getPsiParameters(PsiMethod psiMethod) {
         return Arrays.asList(psiMethod.getParameterList().getParameters());
     }
 
@@ -116,4 +143,30 @@ public static List<JavaModify> getMethodModifies(PsiModifierList modifierList) {
         }
         return result;
     }
+
+    /**
+     * 获取{@code PsiClass}所有字段（包含父类字段）
+     *
+     * @param psiClass
+     * @return
+     */
+    @NotNull
+    public static List<PsiField> getAllPsiFields(PsiClass psiClass) {
+        List<PsiField> result = Lists.newArrayList();
+        recursiveAllFields(psiClass, result);
+        return result;
+    }
+
+    /**
+     * 递归获取类中所有字段
+     * @param psiClass
+     * @param psiFields
+     */
+    private static void recursiveAllFields(PsiClass psiClass, List<PsiField> psiFields) {
+        if (psiClass == null) {
+            return;
+        }
+        psiFields.addAll(Arrays.asList(psiClass.getFields()));
+        recursiveAllFields(psiClass.getSuperClass(), psiFields);
+    }
 }
diff --git a/src/cn/bigcoder/plugin/objecthelper/generator/method/AbstractMethodGenerator.java b/src/cn/bigcoder/plugin/objecthelper/generator/method/AbstractMethodGenerator.java
@@ -6,10 +6,11 @@
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.PsiMethod;
 import com.intellij.psi.PsiParameter;
+import org.apache.commons.collections.CollectionUtils;
 
 import java.util.List;
 
-import static cn.bigcoder.plugin.objecthelper.common.constant.JavaSeparator.*;
+import static cn.bigcoder.plugin.objecthelper.common.constant.JavaKeyWord.*;
 import static cn.bigcoder.plugin.objecthelper.common.util.PsiUtils.*;
 
 /**
@@ -24,14 +25,15 @@ public abstract class AbstractMethodGenerator implements Generator {
     protected PsiMethod psiMethod;
 
     public String generate() {
+        if (!check()) {
+            return null;
+        }
         StringBuilder result = generateMethodFirstLine()
                 .append(generateMethodBody())
                 .append("}");
         return result.toString();
     }
 
-    abstract String generateMethodBody();
-
     protected StringBuilder generateMethodFirstLine() {
         StringBuilder builder = new StringBuilder();
         PsiUtils.getMethodModifies(psiMethod.getModifierList()).forEach(e -> builder.append(e.getName()).append(BLANK_SEPARATOR));
@@ -43,6 +45,24 @@ protected StringBuilder generateMethodFirstLine() {
         return builder;
     }
 
+    /**
+     * 生成方法体
+     * @return
+     */
+    abstract String generateMethodBody();
+
+    /**
+     * 检查是否具备生成方法所需要的环境
+     *
+     * @return true代表校验通过
+     */
+    protected boolean check() {
+        if (CollectionUtils.isEmpty(getParameters()) || VOID.equals(getMethodReturnClassName(psiMethod))) {
+            return false;
+        }
+        return true;
+    }
+
     protected List<PsiParameter> getParameters() {
         return getPsiParameters(psiMethod);
     }
diff --git a/src/cn/bigcoder/plugin/objecthelper/generator/method/ObjectCopyMethodGenerator.java b/src/cn/bigcoder/plugin/objecthelper/generator/method/ObjectCopyMethodGenerator.java
