如何在Aeson的parseJSON解析时校验并拒绝JSON中的未知字段名
实现未知字段自动报错的Aeson解析方案
核心思路
默认Aeson的withObject会静默忽略不在解析逻辑里的字段,只需要在原有解析流程前新增一步字段合法性校验:
- 预先定义允许出现在JSON中的合法字段集合
- 提取JSON对象的所有字段名,找出所有不在合法集合内的非法字段
- 只要存在任意非法字段,直接抛出解析错误,原有可选字段的解析逻辑保持不变
完整修改代码
{-# LANGUAGE RecordWildCards #-} import Data.Aeson import Data.Text import qualified Data.Set as Set -- 定义允许出现的合法字段集合,新增字段时只需更新此处 allowedKeys :: Set.Set Key allowedKeys = Set.fromList ["foo", "bar"] data MyParams = MyParams { mpFoo :: Maybe Text, mpBar :: Maybe Text } deriving Show instance FromJSON MyParams where parseJSON = withObject "MyParams" $ \obj -> do -- 提取JSON对象的所有字段名,校验是否存在非法字段 let allKeys = objectKeys obj illegalKeys = filter (`Set.notMember` allowedKeys) allKeys if not $ null illegalKeys then fail $ "存在非法字段: " <> show illegalKeys else do -- 原有可选字段解析逻辑完全保留 mpFoo <- obj .:? "foo" mpBar <- obj .:? "bar" pure MyParams {..}
效果说明
- 包含
baa、xyz等非foo/bar字段的JSON会直接触发解析失败,不会被静默忽略 - 原有
foo/bar的可选特性不受影响:两个字段任意存在、仅存在一个、都不存在的合法JSON都能正常解析
可选优化
如果字段数量极少,也可以不引入Data.Set依赖,直接用列表做比对:
-- 去掉Data.Set导入,用列表定义合法键 allowedKeys :: [Key] allowedKeys = ["foo", "bar"] -- 校验逻辑改为列表匹配判断 let illegalKeys = filter (`notElem` allowedKeys) $ objectKeys obj
内容的提问来源于stack exchange,提问作者Jivan
相关产品推荐
相关产品推荐

