草庐IT

json - 如何使用 MarshalJSON 将结构转换为具有自定义字段类型的公共(public)结构

coder 2024-07-07 原文

我有一个类型“Book”,我从另一个返回 json 的接口(interface)读取。读取 json 并处理数据后,我必须将图书转换为公共(public)图书类型以隐藏字段并更改输出格式。

我的问题是,同一字段 (ISBN) 的输入类型有时是字符串,有时是整型。我认为最简单的解决方案是使用 json.Number 来解码数据。这行得通 - 但我需要在不同字段的传出 json 上使用字符串......

这就是我需要帮助的地方。我会有一个自定义类型,我可以在字段的公共(public)结构中设置它,我想在其中将 output-json-field 设置为字符串。我在示例中将自定义类型命名为“mytype”。 (真实数据是嵌套的,我在输出中有更多字段设置为字符串 - 公共(public)结构中的 id 字段只是一个测试)

我的意思是,它应该看起来像那样 - 或者不是?

func (m *mytype) MarshalJSON() ([]byte, error) {
    ...
}

这是我的示例代码:https://play.golang.org/p/rS9HddzDMp

package main 

import (  
    "encoding/json"
    "fmt"
    "bytes"
)

/* ----------------------------------------------------------------------------------------------------
Definition of the internal Book object (read from input)
-----------------------------------------------------------------------------------------------------*/
type Book struct {
    Id                      json.Number         `json:"id"`
    Revision                int                 `json:"revision"`
    ISBN                    json.Number         `json:"isbn"`
    Title                   string              `json:"title"`
}

/* ----------------------------------------------------------------------------------------------------
Definition of the public Book object
-----------------------------------------------------------------------------------------------------*/
type AliasBook Book
type omit           *struct{}
type mytype         string

type PublicBook struct {
    Id          string          `json:"id"`
    Revision    omit            `json:"revision,omitempty"`
    ISBN        mytype          `json:"isbn"`
    *AliasBook
}

/* ----------------------------------------------------------------------------------------------------
Rendering functions
-----------------------------------------------------------------------------------------------------*/
func (bb *Book) MarshalJSON() ([]byte, error) {
    fmt.Println("---------------MarschalJSON---------------")
    aux := PublicBook{
        Id:         bb.Id.String(),
        AliasBook:  (*AliasBook)(bb),
    }

    return json.Marshal(&aux)
}

func main() {
    var jsonStreams[2][]byte
    // Input ISBN as string
    jsonStreams[0] = []byte(`{"id":"123","revision":1234,"isbn":"978-3-86680-192-9","title":"Go for dummies"}`)
    // Input ISBN as int
    jsonStreams[1] = []byte(`{"id":123,"revision":1234,"isbn":9783866801929,"title":"Go for dummies"}`)

    // For each stream
    for i := range jsonStreams {
        fmt.Print("stream: ")
        fmt.Println(string(jsonStreams[i]))

        // Read Input
        b := Book{}
        err := json.Unmarshal(jsonStreams[i], &b)
        if err == nil {
            fmt.Printf("%+v\n", b)
        } else {
            fmt.Println(err)
            fmt.Printf("%+v\n", b)
        }

        // Output as JSON
        response := new(bytes.Buffer)
        enc := json.NewEncoder(response)
        enc.SetEscapeHTML(false)
        enc.SetIndent("", "    ")
        err = enc.Encode(&b)
        if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
            fmt.Printf("%+v\n", response)
        }
    }
}

编辑 我有一个适合我的解决方案。 https://play.golang.org/p/Vr4eELsHs1

关键是,我必须使用“fmt.Sprint(*isbn) 来返回编码器中的字符串。我创建了一个新类型,使用 json.Number 函数将输入转换为 int64,然后使用json 自定义编码(marshal)拆收器到字符串。

最佳答案

最简单的解决方案是拥有一个表示 ISBN 编号的自定义类型。然后您可以实现自定义 JSON 解码功能,以便您可以解析字符串和数字输入。例如

type isbn string

func (s *isbn) UnmarshalJSON(buf []byte) error {
    // Read numeric characters only from raw JSON input. This will handle strings, numbers or null etc and strip any
    // optional separators.
    out := make([]byte, 0, len(buf))
    for _, b := range buf {
        if b >= '0' && b <= '9' {
            out = append(out, b)
        }
    }

    // Validate ISBN (assuming not using old 10 digit ISBN)
    l := len(out)
    if l != 13 {
        return errors.New("Invalid ISBN length")
    }
    // Calculate check digit and ensure valid.

    // Create formatted output. This assumes 13 characters for simplicity
    *s = isbn(fmt.Sprintf("%s-%s-%s-%s-%s", out[:3], out[3:4], out[4:9], out[9:12], out[12:]))
    return nil
}

上面只是把ISBN以一种适合输出的格式存储起来。但是,您可以以任何格式存储并有一个单独的 json.Marshaler如果需要,实现格式化输出。

然后您可以像往常一样简单地将其设为Book中的一个字段:

type Book struct {
    Id       json.Number `json:"id"`
    Revision int         `json:"revision"`
    ISBN     isbn        `json:"isbn"`
    Title    string      `json:"title"`
}

上面的 ISBN 解码示例仅用于说明目的。您应该创建一个经过单元测试的完整实现,以确保它正确处理所有预期的输入并在空/格式错误的输入上引发适当的错误。如果这是一个问题,还可以改进性能。

编辑

您不能使用相同的变量在 json.Marshaler 实现中调用 json.Marshal。这将导致无限递归循环,例如

json.Marshal(e) -> e.MarshalJSON -> json.Marshal(e) -> e. MarshalJSON ...

json.Number 类型是数字的字符串表示形式。如果您只是想将所有数字输出为字符串,则根本不需要任何自定义类型。只需在您的代码中使用相关的字符串值。例如:

type PublicBook struct {
    Id          string          `json:"id"`
    // all other fields...
}

// Creates the public book representation from a book
func Public(b *Book) *PublicBook {
  return &PublicBook{
     Id: string(b.Id),
  }
}

这将始终输出一个字符串,因为您使用的是 string 类型,而不是具有自定义 JSON 编码/解码实现的 json.Number 类型。

关于json - 如何使用 MarshalJSON 将结构转换为具有自定义字段类型的公共(public)结构,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/45836035/

有关json - 如何使用 MarshalJSON 将结构转换为具有自定义字段类型的公共(public)结构的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  4. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  5. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  6. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  7. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

  8. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  9. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  10. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

随机推荐