idea使用指南

2022-01-30

插件推荐

.ignore: ignore文件提示与语法高亮插件
arthas idea: arthas 插件
camelcase: 大小写与驼峰转换插件
checkstyle-idea: 代码检测插件
cmdsupport: 脚本执行插件
git Commit template: commit 模板插件
gson format: json 转对象插件
ideavim：vim插件
key promoter x : 快捷键提示插件
lombok: lombok插件
maven helper: maven 帮助插件
save action: 代码保存触发一些操作
sonarlint: sonar 插件
translation: 翻译插件

idea 代码提示

配置模板注释示例(settings 搜 template 找到 file and code templates )：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")

/**
 * Description 
 * Date ${DATE} 
 * Created by ${USER}
 */
public class ${NAME} {
}

后缀代码提示（settings 搜 post 找到postfix completion 在java栏下加后缀）：

.link:

1 2	after: List<$EXPR$> =new LinkList<>();

.list:

1	List<$EXPR$> $END$=new ArrayList<>();

.strmap

1	Map<String,$EXPR$> $END$=new HashMap<>();

live template

/error:
LOGGER.error("==========> [$END$]");
/info
LOGGER.info("==========> [$END$]");
/log
private static final Logger LOGGER = LoggerFactory.getLogger($classname$.class);

todo 设置，settings 搜todo，可以自定义标签，以便对代码进行归档:

1	\b(tag)\b.*

优化配置

maven:

maven->runner:

1	-Dmaven.test.skip=true

Thread count:

带C指定核数，不带C指定线程数

checkStyle 版本选定8.1:

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
          "https://checkstyle.org/dtds/configuration_1_3.dtd">



<module name = "Checker">


  <!-- 检查property文件中是否有相同的key -->
  <module name="Translation"/>
  <!-- 文件长度不超过1500行 -->
  <module name="FileLength">
    <property name="max" value="1500"/>
  </module>



  <!-- 检查文件中是否含有'\t' -->
  <module name="FileTabCharacter"/>

  <module name="RegexpSingleline">
    <property name="format" value="\s+$"/>
    <property name="minimum" value="0"/>
    <property name="maximum" value="0"/>
    <property name="message" value="Line has trailing spaces."/>
  </module>



  <module name="TreeWalker">

    <!-- 单行长度   -->
    <module name="LineLength">
      <property name="max" value="140" />
    </module>
    <!--  检查sout输出   -->
    <module name="Regexp">
      <property name="format" value="System\.out\.println"/>
      <property name="illegalPattern" value="true"/>
      <property name="message" value="不要使用 sout 输出"/>
    </module>

    <!--   print检查   -->
    <module name="Regexp">
      <property name="format" value="printStackTrace"/>
      <property name="illegalPattern" value="true"/>
      <property name="message" value="不要使用 printStackTrace 输出"/>
    </module>
    <!-- 检查方法和构造函数的javadoc -->
    <module name="JavadocMethod">
      <property name="tokens" value="METHOD_DEF" />
    </module>
    <!-- 检查类和接口的javadoc。默认不检查author和version tags -->
    <module name="JavadocType"/>

    <!-- 检查javadoc的格式 -->
	<module name="JavadocStyle">
      <property name="checkFirstSentence" value="false"/>
    </module>
    <!-- 检查TODO:注释 -->
    <module name="TodoComment"/>
    <!-- 命名检查 -->
    <!-- 局部的final变量，包括catch中的参数的检查 -->
    <module name="LocalFinalVariableName" />

	<!-- 检查switch语句是否有default -->
    <module name="MissingSwitchDefault"/>
    <!-- 检查是否有过度复杂的布尔表达式 -->
    <module name="SimplifyBooleanExpression"/>
    <!-- 检查是否有过于复杂的布尔返回代码段 -->
    <module name="SimplifyBooleanReturn"/>
    <!-- 检查类是否为扩展设计l -->
    <!-- <module name="DesignForExtension"/> -->
    <!-- 检查只有private构造函数的类是否声明为final -->
    <module name="FinalClass"/>
    <!-- 检查工具类是否有putblic的构造器 -->
    <module name="HideUtilityClassConstructor"/>
    <!-- 检查接口是否仅定义类型 -->
    <module name="InterfaceIsType"/>
    <!-- 检查类成员的可见度 -->
    <module name="VisibilityModifier"/>


    <!-- 检查分隔符周围是否有空白 -->
    <module name="WhitespaceAround"/>
    <!-- 检查修饰符的顺序是否遵照java语言规范，默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->
    <module name="ModifierOrder"/>
    <!-- 检查接口和annotation中是否有多余修饰符，如接口方法不必使用public -->
    <module name="RedundantModifier"/>
    <!-- 检查是否有嵌套代码块 -->
    <module name="AvoidNestedBlocks"/>
    <!-- 检查是否有空代码块 -->
    <module name="EmptyBlock"/>
    <!-- 检查左大括号位置 -->
    <module name="LeftCurly"/>
    <!-- 检查代码块是否缺失{} -->
    <module name="NeedBraces"/>
    <!-- 检查右大括号位置 -->
    <module name="RightCurly"/>
    <!-- 检查是否在同一行初始化 -->
    <!-- <module name="AvoidInlineConditionals"/> -->
    <!-- 检查空的代码段 -->
    <module name="EmptyStatement"/>
    <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
    <module name="EqualsHashCode"/>
    <!-- 检查局部变量或参数是否隐藏了类中的变量 -->
    <module name="HiddenField">
      <property name="tokens" value="VARIABLE_DEF"/>
    </module>
    <!-- 检查是否使用工厂方法实例化 -->
    <module name="IllegalInstantiation"/>
    <!-- 检查子表达式中是否有赋值操作 -->
    <module name="InnerAssignment"/>
    <!-- 检查是否有"魔术"数字 -->
    <module name="MagicNumber">
      <property name="ignoreNumbers" value="0, 1"/>
      <property name="ignoreAnnotation" value="true"/>
    </module>



	<!-- 方法名后跟左圆括号"(" -->
    <module name="MethodParamPad" />
    <!-- 在类型转换时，不允许左圆括号右边有空格，也不允许与右圆括号左边有空格 -->
    <module name="TypecastParenPad" />
    <!-- Iterator -->
    <!-- <module name="EmptyForIteratorPad"/> -->
    <!-- 检查尖括号 -->
    <!-- <module name="GenericWhitespace"/> -->
    <!-- 检查在某个特定关键字之后应保留空格 -->
    <module name="NoWhitespaceAfter"/>
    <!-- 检查在某个特定关键字之前应保留空格 -->
    <module name="NoWhitespaceBefore"/>
    <!-- 操作符换行策略检查 -->
    <module name="OperatorWrap"/>
    <!-- 圆括号空白 -->
    <module name="ParenPad"/>
    <!-- 检查分隔符是否在空白之后 -->
    <module name="WhitespaceAfter"/>


	<!-- 方法不超过150行 -->
    <module name="MethodLength">
      <property name="tokens" value="METHOD_DEF" />
      <property name="max" value="150" />
    </module>
    <!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->
    <module name="ParameterNumber">
      <property name="max" value="10" />
      <property name="ignoreOverriddenMethods" value="true"/>
      <property name="tokens" value="METHOD_DEF" />
    </module>


	<!-- 局部的非final型的变量，包括catch中的参数的检查 -->
    <module name="LocalVariableName" />
    <!-- 包名的检查（只允许小写字母），默认^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ -->
    <module name="PackageName">
      <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
      <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
    </module>
    <!-- 仅仅是static型的变量（不包括static final型）的检查 -->
    <module name="StaticVariableName" />
    <!-- Class或Interface名检查，默认^[A-Z][a-zA-Z0-9]*$-->
    <module name="TypeName">
      <property name="severity" value="warning"/>
      <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
    </module>
    <!-- 非static型变量的检查 -->
    <module name="MemberName" />
    <!-- 方法名的检查 -->
    <module name="MethodName" />
    <!-- 方法的参数名 -->
    <module name="ParameterName " />
    <!-- 常量名的检查（只允许大写），默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->
    <module name="ConstantName" />
    <!-- 检查数组类型定义的样式 -->
    <module name="ArrayTypeStyle"/>
    <!-- 检查方法名、构造函数、catch块的参数是否是final的 -->
    <!-- <module name="FinalParameters"/> -->
    <!-- 检查long型定义是否有大写的“L” -->
    <module name="UpperEll"/>
    <!-- 避免使用* -->
    <module name="AvoidStarImport"/>
    <!-- 检查是否从非法的包中导入了类 -->
    <module name="IllegalImport"/>
    <!-- 检查是否导入了多余的包 -->
    <module name="RedundantImport"/>
    <!-- 没用的import检查，比如：1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
    <module name="UnusedImports" />

  </module>


</module>

字体等优化：