侧边栏壁纸
博主头像
孔子说JAVA博主等级

成功只是一只沦落在鸡窝里的鹰,成功永远属于自信且有毅力的人!

  • 累计撰写 352 篇文章
  • 累计创建 135 个标签
  • 累计收到 10 条评论

目 录CONTENT

文章目录

IDEA格式化插件 Save Actions 的安装配置与使用

孔子说JAVA
2022-11-03 / 0 评论 / 0 点赞 / 128 阅读 / 3,494 字 / 正在检测是否收录...
广告 广告

Save Actions 是idea一款自动格式化的插件,非常好用,可以大幅提升你的工作效率。它支持可配置的、类似 Eclipse 的保存操作,包括“优化导入”、“重新格式化代码”、“重新排列代码”、“编译文件”和一些针对 Java 的快速修复,如“添加/删除‘这个’限定符”等。插件当文件在磁盘上同步(或保存)时执行配置的操作。

1、Save Actions特点

Save Actions 是idea一款自动格式化的插件,具有以下特点:

  • 在文件保存、快捷方式、批处理(或组合)上运行
  • 通过选择范围在多个文件上运行
  • 重新格式化代码(整个文件或仅更改的文本)
  • 重新排列代码(重新排序方法、字段等)
  • 包含/排除具有正则表达式支持的文件
  • 适用于任何文件类型(Java、Python、XML 等)
  • 使用您可以提交的每个项目的设置文件
  • 可用的键盘映射和激活操作
  • 使用“快速列表”启动任何编辑器操作
  • [Java IDE] Eclipse 配置文件.epf 支持
  • [Java IDE] 自动修复 Java 检查
  • [Java IDE] 保存后编译项目
  • [Java IDE] 保存后重新加载调试器

2、安装方式

2.1 在线安装方式

第一种方式,是在IDEA上搜索插件进行安装,会适配当前IDEA的版本。打开File -> Settings 界面,在左侧列表中找到 Plugins 菜单,在右侧的 Marketplace 页签下,搜索 “save actions”,可以找到对应的插件,如右图所示,点击 Install 进行安装即可,下图为已安装后的截图。

image

2.2 离线安装方式

第二种安装方式是使用离线插件进行安装。插件下载页面:https://plugins.jetbrains.com/idea ,在搜索框中输入插件名称 Save Actions 搜索,点击出现的下拉提示或搜索按钮,即可进入插件下载页面,选择对应安装版本下载即可。

image-1667264872757

image-1667265182134

下载完成后,进入插件市场,选择本地安装

同样是在 Settings 界面,在左侧列表中找到 Plugins 菜单,在右侧的 Installed 页签右方有个齿轮图标,点击展开菜单后选择 “Install Plugin from Disk…”,此时会打开本地文件选择框,选择你下载的插件包安装即可。

image-1667262985024

安装完成后重启IDEA。再打开File -> Settings 界面,在左侧列表中可以找到 Save Actions 菜单,表示你已成功安装了 IDEA 格式化插件 Save Actions。

3、插件常用配置

打开File -> Settings 界面,在左侧列表中找到 Save Actions 菜单,右侧为设置区,下面为常用设置。

  • activate save actions on save – 在保存的时候激活save actions
  • optimize imports – 自动删除没有引用的imports
  • reformat file – 自动格式化代码
  • add missing @Override – 在save actions激活的时候直接添加override
  • add blocks to if/while/for statements – 自动补大括号
  • add a serialVersionUID – 自动添加序列化id

f446561738478e0474a25ecddd184f8

4、插件设置详解

4.1 General 基本设置

  • Activate save actions on save(before saving each file,performs the configured actions below)
    保存时自动格式化

  • Activate save actions on shortcut
    使用快捷键保存时自动格式化
    使用场景:收到一份格式很乱的文件,可以使用这个快捷键自动格式化

  • Activate save actions on batch(Code>Save Actions>Execute on multiple files)
    保存时批量格式化
    这个没用过,因为有的时候你的格式化设置和同事的不一样,一起格式化了会导致合并时候有冲突

4.2 Formatting Actions 格式化触发设置

  • Optimize imports
    优化导入(没有用到的类自动删去import,这个一般要勾选)

  • Reformat file
    重新格式化文件(只要保存文件就会自动格式化)

  • Reformat only change code
    仅仅当代码变化时重新格式化
    以上两个设置是互斥的,意思是,要么代码变化时候触发,要么文件变化时触发

  • Rerrange fields and methods(configured in “File>Setting>Editor>Code Style>(…)>Arragement”)
    重新调整字段和方法的范围

4.3 Build Actions build设置

是在build项目时候用到的设置,这里就不讨论了

4.4 Java Inspection and Quick Fix 具体格式化设置

  • Add final modifier to field
    给字段添加final修饰符

  • Add final modifier to local variable or parameter
    向局部变量或参数添加final修饰符

使用效果如下,所有的局部参数都添加了final修饰符

public void printStr(final String str1, final String str2, final String str3) {
    System.out.println(str1 + str2 + str3);
}

这个选项我不会勾选,因为有的时候形参会发生变化

  • Add final modifier to local variable or parameter except if it is implicit
    向非隐式的局部变量或参数添加final修饰符

  • Add static modifier to methods
    给方法添加static修饰符,效果如下,不要勾选

public static void testStatic(String str) {
    System.out.println(str);
}
  • Add this to field access
    字段的使用加上“this”指针
    可勾可不勾,看个人的使用习惯。

  • Add this to method access
    方法使用加上this
    跟上面那个选项意思差不多,可勾可不勾,看代码习惯

  • Add class qualifier to static member access
    静态成员访问添加类限定符
    就是说静态方法访问了静态变量的话,会自动加上类.变量名,可以点

  • Add class qualifier to static member access outside declaring class
    声明类外的静态成员访问添加类限定符
    和上面那个是互斥的

  • Add missing @Override annotions
    添加漏写的@Override注解
    可以勾选

  • Add blocks to if/while/for statements
    给if/while/for语句添加大括号

public String judgeIt(int a) throws Exception {
    if (a == 3) {
        return "yes";
    }
    throw new Exception();
}
  • Remove blocks from if/while/for statements
    给if/while/for语句移除大括号
public String judgeIt(int a) throws Exception {
    if (a == 3) return "yes";
        throw new Exception();
    }
  • Remove unnessary this to field and method
    给字段或者方法去掉不必要的“this”
    看个人习惯,我不怎么喜欢用this,所以会勾选这个

  • Remove final from private method
    私有方法去掉final关键字

private final String getStr(final String str) {// 设置后final关键字保存时会被去掉
    return str;
}
  • Remove explicit generic type for diamond
    删除显式泛型类型的尖括号

  • Remove unused suppress warning annotation
    移除没用的Suppress警告

  • Remove unnecessary semicolon
    删除不必要的分号

  • Change visibility of field or method to lower access
    更改字段或方法的可见性以降低访问权限

5、插件使用

做了基本设置之后,我们在编辑完文档保存时会自动使用插件的配置对文档进行格式化。

0

评论区