在Haskell的Aeson中省略Nothing / null字段

时间:2017-11-03 16:40:11

标签: haskell template-haskell aeson

我有一个类型

{-# LANGUAGE DeriveGeneric   #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE MultiWayIf      #-}

import GHC.Generics
import Data.Aeson.TH
import Data.Aeson.Types

data MyJSONObject = MyJSONObject
  { name    :: String
  , ptype   :: Maybe String
  , pid     :: Maybe String
  , subject :: Maybe String
  , message :: Maybe String
  } deriving (Show, Generic)

还有更多Maybe String个字段。我的FromJSONToJSONTemplateHaskell函数

提供
$(deriveJSON defaultOptions
  {
    omitNothingFields  = True
  , fieldLabelModifier = \f -> if
      | f == "ptype" -> "type" -- reserved keyword
      | f == "pid"   -> "id"   -- Prelude function name
      | otherwise    -> f
  } ''MyJSONObject)

最终,程序的输出是一个JSON文档,旨在由不允许某些字段具有空值的应用程序使用,即使它确实允许这些字段不存在。换句话说,subject在JSON文档中不存在是完全正常的,但如果确实存在,则其值不能为空。我的期望是omitNothingFields会处理此要求,但情况似乎并非如此:decode d JSON对于不存在的字段仍然具有Nothing值,并且{ {1}} d JSON对这些字段的值为encode。前一种情况很好;后一种情况不是,因此问题。

我是否误用或误解了null的目的?如何忽略omitNothingFields / Nothing值的字段?

1 个答案:

答案 0 :(得分:7)

适合我。尝试使用泛型导出而不是TH。也许这样做。

*Main Data.Aeson> decode "{\"name\":\"str\"}" :: Maybe MyJSONObject
Just (MyJSONObject {name = "str", ptype = Nothing, pid = Nothing, subject = Nothing, message = Nothing})
*Main Data.Aeson> encode (MyJSONObject "str" Nothing Nothing Nothing Nothing)
"{\"name\":\"str\"}"

完整的代码是

{-# LANGUAGE DeriveGeneric   #-}
import GHC.Generics
import Data.Aeson
import Data.Aeson.Types

data MyJSONObject = MyJSONObject
  { name    :: String
  , ptype   :: Maybe String
  , pid     :: Maybe String
  , subject :: Maybe String
  , message :: Maybe String
  } deriving (Show, Generic)

instance ToJSON MyJSONObject where
  toJSON = genericToJSON defaultOptions
    { omitNothingFields = True }

instance FromJSON MyJSONObject where
  parseJSON = genericParseJSON defaultOptions
    { omitNothingFields = True }

使用GHC 8.2.1,aeson-1.1.2.0