资讯详情

Infer 的 MODIFIES_IMMUTABLE 检查器:检测对 @Immutable 标注字段的非法修改

📅 2026/9/22 11:22:26 | 华诺云谱 👁 阅读
Infer 的 MODIFIES_IMMUTABLE 检查器:检测对 @Immutable 标注字段的非法修改
静态分析代码质量开发工具【免费下载链接】inferA static analyzer for Java, C, C, and Objective-C项目地址https://gitcode.com/gh_mirrors/infer/infer点击查看免费下载导读MODIFIES_IMMUTABLE是 Facebook Infer 静态分析器中的一种 issue 类型用于检测程序对标注为Immutable的字段的非法修改。本文将以 MODIFIES_IMMUTABLE.md 文档为骨架结合 IssueType.ml、impurity.ml、impurityDomain.ml 等源码及 ArrayTest.java 测试用例深入讲解该 issue 的触发场景、底层实现原理、配置方法以及实战规避方案。该 Issue 的类型注册与定位MODIFIES_IMMUTABLE在源码中通过register函数注册为一种错误级 issuelet modifies_immutable register ~category:NoCategory ~id:MODIFIES_IMMUTABLE Error Impurity ~user_documentation:[%blob ./documentation/issues/MODIFIES_IMMUTABLE.md]从 IssueType.ml 的注册代码可以看到IDMODIFIES_IMMUTABLE类别NoCategory严重级别Error所属检查器Impurity纯函数/副作用分析触发场景详解MODIFIES_IMMUTABLE表示对标注为Immutable的字段进行了修改。例如下面的函数mutateArray会被标记为修改了不可变字段testArrayImmutable int[] testArray new int[]{0, 1, 2, 4}; int[] getTestArray() { return testArray; } void mutateArray() { int[] array getTestArray(); array[2] 7; }这段代码的关键点在于testArray字段标注了Immutable但其引用类型数组本身是可变的——该注解表达的是该字段所指对象不应被修改的契约通过 getter 拿到数组引用后直接对元素赋值array[2] 7绕过了注解的保护检查器能识别这种通过引用别名间接修改的行为。底层实现原理报告入口在 impurity.ml 中report_immutable_field_modifications负责生成报告let report_immutable_field_modifications tenv impurity_astate proc_desc err_log ... ImpurityDomain.get_modified_immutables_opt tenv impurity_astate | Option.iter ~f:(fun (modified_immutable_params, modified_immutable_globals) - ... Reporting.log_issue proc_desc err_log ~loc ~ltr Impurity IssueType.modifies_immutable immutable_fun_desc )其报告消息格式为Function %a modifies immutable fields即函数 XX 修改了不可变字段。触发开关在 impurity.ml 中该检查默认关闭需要显式开启if Config.impurity_report_immutable_modifications then report_immutable_field_modifications tenv impurity_astate proc_desc err_log ;对应的配置项为--impurity-report-immutable-modifications。核心判定逻辑在 impurityDomain.ml 中filter_modifies_immutable是核心判定函数let filter_modifies_immutable tenv ~f ModifiedVarMap.filter (fun _pvar ModifiedAccess.{ordered_access_list} - List.exists ordered_access_list ~f:(fun access - match access with | Access.FieldAccess fname - let class_name Fieldname.get_class_name fname in implements_immutable_map tenv class_name || Tenv.lookup tenv class_name | Option.exists ~f:(fun mstruct - f mstruct | List.exists ~f:(fun {Struct.name fieldname; typ _typ; annot} - String.equal (Fieldname.get_field_name fieldname) (Fieldname.get_field_name fname) Annotations.ia_has_annotation_with annot (fun annot - Annotations.annot_ends_with annot Annotations.immutable ) ) ) | _ - false ) )get_modified_immutables_opt分别对被修改的参数modified_params对应实例字段fields和被修改的全局变量modified_globals对应静态字段statics做过滤只要两者中任一非空就返回可报告的不可变修改集合。从中可以提炼出三个事实该检查基于 Impurity 分析记录下的被修改字段访问路径Access.FieldAccess fname逐层匹配匹配时要求字段名一致且字段注解以Immutable结尾支持Immutable及自定义的Immutable...家族注解特殊的ImmutableIntHashMap类型也被视为不可变容器可被同类规则约束见implements_immutable_map。实测场景测试用例与预期输出仓库中提供了完整的测试用例 ArrayTest.java覆盖了多种触发路径场景方法是否报告直接修改不可变数组元素array_mod_badERROR通过 getter 拿引用后修改mutate_array_via_getter_badERROR通过二次别名修改mutate_array_via_aliasing_badERROR将引用传给 callee 修改mutate_array_via_callee_badERROR修改静态不可变数组mutate_static_array_badERROR修改可变未标注数组mutable_array_mod_ok不报告混合修改含一次非法调用mixed_mod_badERROR修改传入对象参数上的不可变字段mutate_arg_badERROR对应的预期输出文件 issues.exp 给出了精确到行的报告格式例如codetoanalyze/java/immutability/ArrayTest.java, codetoanalyze.java.immutability.ArrayTest.mutate_array_via_getter_bad():void, 0, MODIFIES_IMMUTABLE, no_bucket, ERROR, [Function void ArrayTest.mutate_array_via_getter_bad() modifies immutable fields,parameter this.*testArray*[] modified here]可以看到报告不仅指出函数名还给出了具体被修改的路径parameter this.*testArray*[] modified here对定位问题非常有帮助。此外 OuterTest.java 还覆盖了跨对象嵌套字段的修改场景this.*arrays*[]*testArray*[]。值得注意的是测试 Makefile 中使用了INFER_OPTIONS \ --impurity-only --no-pulse-force-continue --impurity-report-immutable-modifications \ --disable-issue-type IMPURE_FUNCTION这验证了运行该检查的完整命令组合Impurity 分析模式 开启不可变修改报告同时可关闭同族的IMPURE_FUNCTION噪音。如何运行与配置命令行启用由于默认关闭需要在infer analyze或infer run时显式传入infer run --impurity-only --impurity-report-immutable-modifications -- javac YourClass.java其中--impurity-only只运行 Impurity 检查器避免其他检查器的干扰--impurity-report-immutable-modifications开启MODIFIES_IMMUTABLE报告对应 impurity.ml 中的配置读取逻辑如需在报告中去掉纯函数自身不纯的噪音可追加--disable-issue-type IMPURE_FUNCTION。命令行删除若需在 CI 中忽略该类问题可使用通用的 issue 过滤机制infer run --disable-issue-type MODIFIES_IMMUTABLE -- javac YourClass.java实战规避建议要从根源上避免MODIFIES_IMMUTABLE不要对外暴露不可变字段的可变引用。将 getter 改为返回副本或只读视图避免调用方获得可变句柄数组/集合等容器慎用Immutable。如需不可变契约优先使用不可变容器如Collections.unmodifiableList、ImmutableIntHashMap等后者在 impurityDomain.ml 中被特殊识别避免跨方法传递引用后再修改。即便修改发生在 callee 中Impurity 的调用链追踪依然能回溯到源头并报告明确标注意图。可变字段不要标注Immutable以免掩盖真实的可变性设计也避免检查器误报。总结MODIFIES_IMMUTABLE是 Infer Impurity 检查器提供的一道面向不可变契约的护栏它在 Pulse 摘要之上追踪字段级别的修改路径能穿透 getter、别名、跨函数调用等间接方式识别对Immutable字段的修改并以Error级别报告。虽然该检查默认关闭但通过--impurity-report-immutable-modifications一行配置即可启用配合 ArrayTest.java 中的完整测试矩阵开发者可以快速验证并接入 CI保障不可变契约在工程中真正落地。赞分享静态分析代码质量开发工具【免费下载链接】inferA static analyzer for Java, C, C, and Objective-C项目地址https://gitcode.com/gh_mirrors/infer/infer点击查看免费下载相关推荐Slide离线阅读功能详解随时随地浏览Reddit内容的完整教程Slide离线阅读功能详解随时随地浏览Reddit内容的完整教程 你是否经常在地铁、飞机或网络信号不佳的地方想要浏览RedditSlide for Redd静态分析代码质量开发工具Infer 的 BLOCK_PARAMETER_NOT_NULL_CHECKED 检查器Objective-C Block 参数空值检测与修复指南Infer 的 BLOCK_PARAMETER_NOT_NULL_CHECKED 检查器Objective C Block 参数空值检测与修复指南 本文基于静态分析代码质量开发工具让旧Mac焕发新生OpenCore Legacy Patcher完整升级指南让旧Mac焕发新生OpenCore Legacy Patcher完整升级指南 你是否还在为2012年的MacBook Pro无法升级macOS Ventura操作系统固件驱动开发上一篇Hippo4j线程池隔离实践基于业务场景的线程池分组管理下一篇YOLOv6推理速度优化从输入预处理到后处理全链路优化创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
📝

华诺云谱内容团队

资深建站顾问 · 行业研究员

10年+企业数字化服务经验,专注智能建站、SEO优化与品牌营销,持续输出建站技巧、行业洞察与营销干货,已帮助5000+企业实现数字化增长。

你可能需要的服务

订阅华诺云谱资讯周报

每周一封,精选建站技巧、SEO与营销干货,直达邮箱。已有 8,000+ 企业主订阅,助你少走弯路。