一、引言

每一个公司,团队的代码风格可能都不一样,只要团队内有自己统一的风格就好。接下来,介绍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代码风格内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com!