JJWT库中JWT构建时非字符串类型audience声明的处理问题

背景介绍

JJWT是一个广泛使用的Java JWT(JSON Web Token)库，在0.12.0版本中对JWT构建时的audience(aud)声明处理方式进行了重大变更。这一变更导致了一些向后兼容性问题，特别是当开发者尝试使用非字符串类型的aud声明时。

问题现象

在JJWT 0.12.0及以上版本中，当开发者尝试构建JWT时，如果aud声明不是字符串类型，会抛出IllegalArgumentException异常。具体表现为：

1. 当aud声明为List类型时，错误信息为："Invalid Map 'aud' (Audience) value: [invalid-clientId, test-aud]. Unsupported value type. Expected: java.lang.String, found: java.util.ArrayList"

2. 当aud声明为Boolean类型时，错误信息为："Invalid Map 'aud' (Audience) value: true. Unsupported value type. Expected: java.lang.String, found: java.lang.Boolean"

技术原因

这一变更源于JJWT对RFC 7519规范的更严格实现。根据JWT规范：

• audience声明(aud)可以接受两种形式：
  • 单个字符串值
  • 字符串数组(即List)

JJWT 0.12.0版本引入了更严格的类型检查，确保aud声明符合规范要求。任何不符合这两种形式的aud值都会被拒绝。

解决方案

1. 使用新的Builder API

JJWT 0.12.0引入了专门的audience构建器来正确处理aud声明：

// 单个audience值
Jwts.builder().audience().add("single-audience").and()...

// 多个audience值
List<String> audiences = Arrays.asList("aud1", "aud2");
Jwts.builder().audience().add(audiences).and()...

2. 避免使用通用claim方法

不再推荐使用通用的claim()方法来设置aud声明：

// 不推荐 - 可能导致异常
Jwts.builder().claim("aud", someValue)...

// 特别避免以下用法
Jwts.builder().claim("aud", true)...  // Boolean类型
Jwts.builder().claim("aud", 123)...   // 数字类型

3. 类型安全考虑

开发者应当注意：

• 只使用String或List作为aud值
• 其他类型(如Boolean、Number等)不符合规范，会被拒绝
• 从0.12.0开始，类型检查更加严格，这是为了确保生成的JWT完全符合标准

迁移建议

对于从旧版本迁移的开发者：

1. 检查所有设置aud声明的代码
2. 将使用claim("aud", ...)的地方改为使用新的audience构建器API
3. 确保所有aud值都是字符串或字符串集合
4. 添加适当的测试来验证aud声明的设置

总结

JJWT 0.12.0对aud声明的处理更加规范和安全，虽然这带来了一些迁移成本，但有助于生成符合标准的JWT。开发者应当使用新的audience构建器API来设置aud声明，并确保只使用规范允许的类型。这一变更体现了JJWT项目对标准合规性的重视，有助于提高JWT的互操作性和安全性。