Moshi JSON库使用教程

Moshi JSON库使用教程

moshiA modern JSON library for Kotlin and Java.项目地址:https://gitcode.com/gh_mirrors/mo/moshi

项目介绍

Moshi 是一个现代的 JSON 库，适用于 Android、Java 和 Kotlin。它使得解析 JSON 数据到 Java 和 Kotlin 类变得简单。Moshi 建立在 Okio 之上，使用 Okio 进行简单而强大的 I/O 操作。它借鉴了 Gson 的流式处理和绑定机制，但与 Gson 相比，Moshi 具有更少的内置类型适配器，并且对平台类型的序列化有更严格的限制。

项目快速启动

添加依赖

首先，在你的项目中添加 Moshi 依赖。如果你使用 Maven，添加以下依赖：

<dependency>
    <groupId>com.squareup.moshi</groupId>
    <artifactId>moshi</artifactId>
    <version>1.15.1</version>
</dependency>

如果你使用 Gradle，添加以下依赖：

implementation("com.squareup.moshi:moshi:1.15.1")

基本使用

以下是一个简单的示例，展示如何使用 Moshi 解析 JSON 数据并将其序列化为 Java 对象。

import com.squareup.moshi.JsonAdapter;
import com.squareup.moshi.Moshi;
import com.squareup.moshi.Types;

import java.io.IOException;
import java.util.List;

public class Main {
    public static void main(String[] args) {
        String json = "[{\"name\":\"Alice\", \"age\":30}, {\"name\":\"Bob\", \"age\":25}]";

        Moshi moshi = new Moshi.Builder().build();
        JsonAdapter<List<Person>> jsonAdapter = moshi.adapter(Types.newParameterizedType(List.class, Person.class));

        try {
            List<Person> persons = jsonAdapter.fromJson(json);
            System.out.println(persons);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

class Person {
    String name;
    int age;

    @Override
    public String toString() {
        return "Person{name='" + name + "', age=" + age + "}";
    }
}

应用案例和最佳实践

自定义类型适配器

Moshi 允许你创建自定义的类型适配器来处理特定的数据类型。例如，如果你需要处理日期类型，可以创建一个自定义的适配器。

import com.squareup.moshi.FromJson;
import com.squareup.moshi.ToJson;

import java.text.SimpleDateFormat;
import java.util.Date;

public class DateAdapter {
    private final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");

    @FromJson
    Date fromJson(String json) throws Exception {
        return dateFormat.parse(json);
    }

    @ToJson
    String toJson(Date date) {
        return dateFormat.format(date);
    }
}

使用 Kotlin 代码生成

如果你使用 Kotlin，可以利用 Moshi 的 Kotlin 代码生成功能来简化适配器的创建。

import com.squareup.moshi.JsonClass
import com.squareup.moshi.Moshi
import com.squareup.moshi.adapter
import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory

@JsonClass(generateAdapter = true)
data class User(val name: String, val age: Int)

fun main() {
    val json = """{"name":"Alice", "age":30}"""
    val moshi = Moshi.Builder().add(KotlinJsonAdapterFactory()).build()
    val jsonAdapter = moshi.adapter<User>()

    val user = jsonAdapter.fromJson(json)
    println(user)
}

典型生态项目

OkHttp

Moshi 与 OkHttp 配合使用可以实现高效的网络请求和 JSON 数据处理。OkHttp 是一个高效的 HTTP 客户端，可以与 Moshi 共享缓冲区段以提高效率。

Retrofit

Retrofit 是一个类型安全的 HTTP 客户端，可以与 Moshi 集成以处理

moshiA modern JSON library for Kotlin and Java.项目地址:https://gitcode.com/gh_mirrors/mo/moshi