checkstyle检查Java编程样式:识别应该被定义为final的类

介绍

总体说明

checkstyle可以使用FinalClass检查应该被定为final的类。如果违反了,就会报违反项:
https://checkstyle.sourceforge.io/checks/design/finalclass.html

checkstyle规则集文件对FinalClass模块的配置:
checkstyle检查Java编程样式:识别应该被定义为final的类_第1张图片

哪些类可以被定义final的

原则是不允许被继承的类用final修饰。

在具体判定方法上,checkstyle认为如下类要用final修饰:

  • 一个类只包含private的构造函数。

下面的类会被checkstyle跳过:

  • 是匿名内部类的父类。

示例

只有匿名构造函数的类被定义为final的—checkstyle检查通过

checkstyle检查Java编程样式:识别应该被定义为final的类_第2张图片

只有匿名构造函数的类没有被final修饰—checkstyle检查报违反项

checkstyle检查Java编程样式:识别应该被定义为final的类_第3张图片
checkstyle检查Java编程样式:识别应该被定义为final的类_第4张图片

一个类有一个private构造函数和一个public构造函数,不被定义为final的—checkstyle检查通过

下面的类Parent有一个private构造函数,和一个public构造函数,所以不需要定义为final的:

package com.thb;

public class Parent {

    /**
     * 整型字段.
     */
    private int field1;
    /**
     * 字符串字段.
     */
    private String filed2;

    /**
     * 构造函数.
     * @param value
     */
    public Parent(final String value) {
        this.filed2 = value;
        this.field1 = 0;
    }

    /**
     * 私有构造函数.
     * @param value
     */
   private Parent(int value) {
       this.field1 = value;
       this.filed2 = "hello";
   }
}

是匿名内部类的父类,不被定义为final的—checkstyle检查通过

checkstyle检查Java编程样式:识别应该被定义为final的类_第5张图片

外部类只有private构造函数,含有匿名内部类,但不是该匿名内部类的父类,外部类定义为final的—checkstyle检查通过

下面的父类只含有private的构造函数,含有一个匿名内部类,但不是该匿名内部类的父类,所以父类要被定义为final的:
checkstyle检查Java编程样式:识别应该被定义为final的类_第6张图片

外部类只有private构造函数,含有匿名内部类,但不是该匿名内部类的父类,外部类没有定义为final的—checkstyle检查报违反项

下面的父类只含有private的构造函数,含有一个匿名内部类,但不是该匿名内部类的父类,父类没有定义为final的,checkstyle检查报违反项:
checkstyle检查Java编程样式:识别应该被定义为final的类_第7张图片

checkstyle检查Java编程样式:识别应该被定义为final的类_第8张图片

接口中的嵌套类只有private构造函数,该嵌套类没有定义为final的—checkstyle检查报违反项

checkstyle检查Java编程样式:识别应该被定义为final的类_第9张图片
checkstyle检查Java编程样式:识别应该被定义为final的类_第10张图片

接口中的嵌套类只有private构造函数,该嵌套类定义为final的—checkstyle检查通过

checkstyle检查Java编程样式:识别应该被定义为final的类_第11张图片

注解中的嵌套类只有private构造函数,该嵌套类没有定义为final的—checkstyle检查报违反项

checkstyle检查Java编程样式:识别应该被定义为final的类_第12张图片
checkstyle检查Java编程样式:识别应该被定义为final的类_第13张图片

注解中的嵌套类只有private构造函数,该嵌套类定义为final的—checkstyle检查通过

checkstyle检查Java编程样式:识别应该被定义为final的类_第14张图片

你可能感兴趣的:(java,checkstyle)