敏感词过滤库houbb/sensitive-word中NullPointerException问题解析

敏感词过滤是许多互联网应用中必不可少的功能，houbb/sensitive-word作为一个开源的Java敏感词过滤库，提供了强大的敏感词检测能力。但在实际使用过程中，开发者可能会遇到一些配置上的问题，特别是当自定义敏感词列表返回null值时导致的NullPointerException异常。

问题背景

在使用houbb/sensitive-word库时，开发者通常会通过实现IWordDeny接口来自定义敏感词黑名单。在示例代码中，WordDeny类实现了这个接口，当数据库查询不到敏感词时直接返回了null值。这会导致在初始化SensitiveWordBs时抛出NullPointerException异常，错误信息显示"java.util.Collection.toArray()"因为"c"是null而无法调用。

问题根源分析

问题的本质在于库内部处理敏感词列表时，假设传入的集合对象永远不会为null。当自定义实现返回null时，库尝试在null引用上调用集合操作方法，自然就会抛出空指针异常。这是一种典型的防御性编程不足的情况。

解决方案演进

最初，社区建议的解决方案是在自定义实现中返回一个空的ArrayList而不是null。这种做法遵循了"返回空集合而非null"的最佳实践，可以有效避免NPE问题。

@Override
public List<String> deny() {
    // 查询逻辑...
    if(CollectionUtil.isNotEmpty(sensitiveWords)){
        return sensitiveWords.stream().map(SensitiveWord::getSensitiveWord).toList();
    } else {
        return new ArrayList<>(); // 返回空集合而非null
    }
}

后来，库的作者在v0.18.1版本中对此进行了改进，使库能够兼容处理null值的情况。这意味着即使自定义实现返回null，库也能正常处理而不会抛出异常。这种改进体现了良好的向后兼容性和鲁棒性设计。

最佳实践建议

1. 防御性编程：无论是库开发者还是使用者，都应该遵循防御性编程原则。作为库使用者，即使知道库已经处理了null情况，也应该考虑返回空集合而非null。

2. 版本管理：及时关注依赖库的版本更新，特别是修复了已知问题的版本。在示例中，升级到v0.18.1或更高版本可以避免这个问题。

3. 文档阅读：使用开源库时，仔细阅读其文档和常见问题，了解接口契约和预期行为。好的库文档通常会明确指出参数和返回值的约束条件。

4. 单元测试：编写单元测试验证边界条件，包括空集合、null值等特殊情况，确保代码在各种情况下都能正常工作。

总结

这个案例展示了在实际开发中如何处理第三方库的异常情况，以及如何通过社区协作解决问题。它不仅解决了具体的技术问题，也体现了开源社区协作的价值。作为开发者，我们既可以从使用者的角度学习如何正确配置和使用开源库，也可以从维护者的角度学习如何改进自己的项目以提供更好的用户体验。