Java黑科技之通过Google Java Style 文件配置IDEA和Ecplise代码风格

一、引言

每一个公司，团队的代码风格可能都不一样，只要团队内有自己统一的风格就好。接下来，介绍Google Java 代码风格，并且如何在IDEA和Ecplise两种比较流行的Java集成开发环境中配置Google Java 代码风格。

如果不看google代码风格详细介绍的，可以下拉到最后查看 IDEA 和 Ecplise 配置 Google Java Style 教程和 Google Java Style 文件下载。

二、Google Java Style 介绍

2.1 源文件基础

文件名

Java源文件名区分大小写的，并且首字母大写，以.java扩展名结束。

文件编码

Java源文件编码格式为UTF-8。

特殊字符

• 空格字符：除了行结束符之外，ASCII水平空格字符（0x20）是唯一出现在源文件中任何地方的空格字符。这也意味着，字符串和字符文字中的所有其他空白字符均被转义。制表符不用于缩进。
• 特殊的转义序列：所有转义序列 （\ b， \ t， \ n， \ f， \ r， \ "， \ ' 和 \\），不是八进制（例如 \ 012）或Unicode（例如 \ u000a）的转义。
• 非ASCII字符：对于其余的非ASCII字符，则使用实际的Unicode字符（例如∞）或等效的Unicode转义符（例如 \ u221e）。用哪种取决于使代码更易于阅读和理解，尽管Unicode会在字符串文字之外进行转义，但是不建议不在注释中使用。例如String unitAbbrev = "μs"，没必要写成String unitAbbrev = "\u03bcs"。

2.2 源文件结构

一个Java源文件，按以下顺序组成，并且每个部分空一行分隔开：

1.许可或版权信息（如果有）

2.Package语句，并且不换行的

3.Import语句，最后不要使用通配符导入，无论是静态导入还是其他方式；每一行导入语句都是不换行的；所有静态导入都在一个块中，所有非静态导入也在同一个块中，块之间用一空白行分隔开；在每个块中，导入的名称均按ASCII排序顺序显示。

4.顶级类定义

每一个顶级类都应该在一个单独的源文件中，对于一个类中的内容，最好是有意识地对类中的内容按某种规则排序排版，例如新的方法一般添加在类的尾部，这样我们可以根据时间线索了解这些方法何时加进来的；再比如，当一个类具有多个构造函数或多个具有相同名称的方法时，它们将顺序出现，并且它们之间没有其他代码（甚至没有私有成员）。

2.3 格式化

前提须知，下文中提及的块状结构是指类的主体，方法或构造函数。

花括号

if，else，for，do，while 等语句块使用花括号，即使花括号内容是空的或者只有一行语句。

对于内容非空的花括号块，遵循以下规则：

左括号前不换行

左括号后换行

右括号前换行

右括号后换行，如方法块，构造函数，类的主体括号情况下才换行。有些整体搭配不换行，例如esle前面的右括号，try块的右括号等。

return () -> {
  while (condition()) {
    method();
  }
};

return new MyClass() {
  @Override public void method() {
    if (condition()) {
      try {
        something();
      } catch (Exception e) {
        recover();
      }
    } else if (otherCondition()) {
      somethingElse();
    } else {
      lastThing();
    }
  }
};

对于一些空内容的块，以下两种方式都可接受：

void doNothing() {}

  void doNothingElse() {
  }

缩进

关于一些块结构等的缩进，建议2个空格，并且注释也最好和代码缩进保持一致。

每行一个声明

每个语句后都有一个换行符，不要将多行语句都写在同一行。

列数限制

Java代码的列数限制为100个字符，一个字符是指一个Unicode字符。除非另有说明，否则超出该限制的任何行都必须进行换行。

不过也有一些例外可以超过此限制，例如：

• Javadoc中的长URL或长的JSNI方法引用
• package和import语句
• 注释中的命令行，因为可能需要将其拷贝到shell中执行

不要水平对齐

水平对齐是在下一行的代码中添加一些空格，致使与上一行的某个标识符对齐。语法允许这样做，但是不推荐，因为后续可能会载修改代码，可能导致不再对齐，然后再对齐的话需要浪费额外的时间精力。

// 这是推荐的，按正常的一个空格即可
private int x;
private Color color;

// color和x对齐，没必要
private int   x;
private Color color;

枚举类

如果一个枚举常量有方法或者注释，在每个枚举常量的逗号后面，最好换一行再定义下一个枚举常量。

private enum Answer {
  YES {
    @Override public String toString() {
      return "yes";
    }
  },
  NO,
  MAYBE
}

如果一个枚举常量没有有方法或者注释，则可以不换行。

private enum Suit { CLUBS, HEARTS, SPADES, DIAMONDS }

变量声明

每个变量声明语句只声明一个变量，不要使用 int a, b;这种多变量的声明。但是for循环的头部中可以接受多个变量声明 。

需要时才声明，不要在代码块的开头就声明局部变量，而是应该在靠近使用局部变量的地方声明它们，以最小化它们的作用域。局部变量应该声明的时候就进行初始化，或者声明后，要立即初始化。

数组

[]方括号应该是类型的一部分，而不是变量，所以应该使用String[] args，而不是 String args[]。

Switch语句

在Switch代码块内，如果一个case小代码块直接穿透到下一个case（例如没有以break，continue，return或者抛异常结尾），则需要在最后一个case后面注释说明原因；最后一定要写default块，即使没有执行任何代码，但是如果switch的是枚举类型，并且case列出所有的枚举值了，可以不用写default。

switch (input) {
  case 1:
  case 2:
    prepareOneOrTwo();
    // 这里说明为什么穿透，case1和case2的情况下也要执行case3的内容
  case 3:
    handleOneTwoOrThree();
    break;
  default:
    handleLargeNumber(input);
}

修饰符

类或者成员变量的定义使用修饰符时，按以下顺序进行修饰。

public protected private abstract default static final transient volatile synchronized native strictfp

字面量

long类型的值，数字后面加大写的L，禁止使用小写的l，因为l和1很像，容易误导。例如300000L而不是300000l。

三、标识符命名规则

package命名规则

package的包名全部小写，而且不要出现下划线（_），例如使用com.nobody.chenpi，而不是com.nobody.chenPi 或者com.nobody.chen_pi。

类命名规则

类名遵循UpperCamelCase规则，即大写字母开头的驼峰规则。类名使用名词或者名称短语，例如Person，GoodPerson。接口使用名称或者名称短语，有时也可以使用形容词或者形容词短语，例如Readable。

测试类名字以需要测试的类的名字开头，并且以Test结尾，例如HashTest 。

方法命名规则

方法命名遵循lowerCamelCase规则，即小写字母开头的驼峰规则。方法名词使用动词或者动词短语，例如sendMessage。

常量命名规则

常量名称全部大写，并且单词之间用下划线分隔开。

private static final Long MAX_NUM = 10000L;

还有需要Google代码风格规则就不一一讲解了，感兴趣的可以到google官方查看。

IDEA 配置 Google Java Style

点击File(文件）–> Setting(设置) –> Editor(编辑) –> Code Style(代码风格)，然后再点击Scheme右边的设置按钮，Import Scheme，IntelliJ IDEA code style xml。最后选中本地下载好的xml文件。

然后为选中导入的主题取个名称，在最上面Scheme选项选中我们的主题确定即可。

然后我们在使用IDEA开发代码过程中，使用快捷键（默认是ctrl + alt + L，也可以修改设置这个快捷键），即可按google风格进行格式化代码。

package com.nobody.exception;

import lombok.Getter;

/**
 * @Description 自定义通用异常枚举类
 * @Author Mr.nobody
 * @Date 2020/10/23
 * @Version 1.0
 */
@Getter
public enum CommonErrorEnum implements BaseErrorInfo {

  /**
   * 成功
   */
  SUCCESS("200", "成功!"),
  /**
   * 请求的数据格式不符!
   */
  BODY_NOT_MATCH("400", "请求的数据格式不符!"),
  /**
   * 未找到该资源!
   */
  NOT_FOUND("404", "未找到该资源!"),
  /**
   * 服务器内部错误!
   */
  INTERNAL_SERVER_ERROR("500", "服务器内部错误!"),
  /**
   * 服务器正忙，请稍后再试!
   */
  SERVER_BUSY("503", "服务器正忙，请稍后再试!");

  private String errorCode;
  private String errorMsg;

  CommonErrorEnum(String errorCode, String errorMsg) {
    this.errorCode = errorCode;
    this.errorMsg = errorMsg;
  }
}

四、Ecplise 配置 Google Java Style

路径：Window - Preferences - Java - Code Style - Formatter - Import，然后导入xml文件，最后选择GoogleStyle，保存即可。

到此这篇关于Java黑科技之通过Google Java Style 文件配置IDEA和Ecplise代码风格的文章就介绍到这了,更多相关配置IDEA和Ecplise代码风格内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！