如何利用自研Checkstyle静态检查工具强行约束源码中的集合滥用红线

夜枫姑娘_9889

夜枫姑娘_9889

2026-06-07

799人浏览

原创

必须用自定义checkstyle规则在编译前拦截集合滥用:识别空集合调用get(0)/element()、arraylist/linkedlist作共享缓存、map.put(key,null)三类高危模式,基于ast扫描method_call和new_class节点,无有效防护即报错阻断,并配套修复模板与安全替代方案。

如何利用自研checkstyle静态检查工具强行约束源码中的集合滥用红线

直接在源码中拦截集合滥用,不能靠运行时或人工提醒——必须用自定义 Checkstyle 规则,在编译前就报错。核心是识别高危模式并阻断,不是提示或警告。

识别三类典型集合滥用场景

静态检查要盯紧以下明确违反安全红线的行为:

  • 空集合直接调用 get(0)、element()、remove(0) 等下标/首元素操作:如 list.get(0) 出现在未判空或未校验 size 的上下文中
  • 用 ArrayList 或 LinkedList 做高频读写共享缓存:检测到 new ArrayList() / new LinkedList() 出现在被 @Service、@Component 或静态字段修饰的类中,且方法体含多线程访问特征(如含 synchronized、Lock、volatile 关键字)
  • Map.put(key, null) 或 List.add(null):对泛型为非 ? 的集合执行显式 null 插入,且该集合声明未标注 @Nullable

编写自定义 Checkstyle 检查器

继承 AbstractCheck,重写 visitToken 方法,基于 AST 节点做语义判断:

Lumen5
Lumen5

一款面向内容营销的视频制作平台,可将文章、博客等文字内容转换为视频,并结合模板和素材完成视觉化表达。

下载
  • 扫描 METHOD_CALL 节点,匹配 get、element、remove 等方法名,并向上查找最近的 VARIABLE_DEF 或 PARAMETER_DEF,确认其类型是否为 List / Deque 子类
  • 沿父节点回溯,检查是否被 if、while 或 assert 包裹,且条件中含 .size() > 0、!= null、!isEmpty() 等有效防护逻辑;若无,则报错
  • 对 NEW_CLASS 节点,提取构造器参数类型与所在作用域(类注解、字段修饰符),结合白名单包名(如 test、mock)做排除

集成到构建与开发流程

规则生效需闭环落地:

  • 在 checkstyle.xml 中启用自定义模块:
    <module name="ProhibitUnsafeCollectionAccess"><br>  <property name="allowedCollections" value="java.util.concurrent.CopyOnWriteArrayList,com.google.common.collect.ImmutableList"></property><br></module>
  • Maven 配置中设置 <failsonerror>true</failsonerror>,CI 流水线中触发 mvn validate 即阻断
  • IDEA 中配置 Checkstyle 插件指向同一 checkstyle.xml,开启实时高亮,错误行直接标红不可提交
  • 对历史代码允许临时豁免,但需在 suppressions.xml 中按行号精确声明,并绑定 Jira 编号与整改时限

配套规范与替代方案引导

只报错不给路会引发抵触,规则需自带“出口”:

  • 当检测到 list.get(0) 无防护时,建议快速修复模板:list.isEmpty() ? null : list.get(0) 或 list.stream().findFirst().orElse(null)
  • 对共享缓存场景,自动提示替换为 ConcurrentHashMap、CacheBuilder.newBuilder().build() 或团队封装的 SafeCache 工具类
  • 所有集合字段声明强制要求加 @NonNull / @Nullable 注解(通过另一个 Checkstyle 规则保障),让 null 安全可追溯

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9577

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6742

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5972

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1044

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

868

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1256

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2509

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19851

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1135

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Fitten Code官方手册
Fitten Code官方手册

共0课时 | 0人学习

Microsoft Copilot官方手册
Microsoft Copilot官方手册

共0课时 | 0人学习

通义灵码手册
通义灵码手册

共0课时 | 0人学习