1.Moshi是什么?
Moshi是由Square公司开源项目。
可以实现Json序列化和反序列化的框架。
在java中我们经常使用Gson、FastJson 来实现序列化和反序列化,由于kotlin的一些新特性以上框架不支持,所以才有了Moshi的诞生,
2.为什么要有Moshi/能解决什么问题?
Kotlin中有可以有默认参数,这个在其他框架里面是无法获取到的,Moshi是可以的。
Kotlin的不为空,当解析的数据为null时会解析报错
3.Moshi的使用,首先是导入包
implementation 'com.squareup.moshi:moshi:1.8.0'//这个包是必须要导入的
kapt 'com.squareup.moshi:moshi-kotlin-codegen:1.8.0'//需要在bean对象上使用注解@JsonClass(generateAdapter=true)
plugins添加 id 'kotlin-kapt'
//下面引入不建议使用,内部引入了KotlinReflect的Jar包,大概2.5M
//使用以下依赖的话需要在创建Moshi的时候添加KotlinJsonAdapterFactory()
//Moshi.Builder().add(KotlinJsonAdapterFactory()).build()
//implementation 'com.squareup.moshi:moshi-kotlin:1.8.0'
以下代码我们都已kapt 'com.squareup.moshi:moshi-kotlin-codegen:1.8.0'为例
4.解析的Bean
上添加注解@JsonClass(generateAdapter=true)
我们定义个Person类,默认的国家是中国
@JsonClass(generateAdapter=true)
data class Person(var name:String,var age:Int,var country:String="中国")
fun main() {
val person = Person("xiaoming",12)
//创建Moshi,通过导入implementation "com.squareup.moshi:moshi-kotlin:1.11.0" 包的话必须设置KotlinJsonAdapterFactory()
val moshi = Moshi.Builder().build()
//获取对应类的adapter
val adapter = moshi.adapter(Person::class.java)
//adapter.toJson 把对象变成json
println(adapter.toJson(person))
}
运行我们会看到控制台打印出以下内容,把默认数据中国给添加进去了
{"name":"xiaoming","age":12,"country":"中国"}
拿到上面的Json数据我们就可以把Json反序列化为我们的对象了。
fun main(){
val json="{\"name\":\"xiaoming\",\"age\":12,\"country\":\"中国\"}"
val build = Moshi.Builder().build()
val adapter = build.adapter<Person>(Person::class.java)
val person = adapter.fromJson(json)
println(person)
}
执行以上代码我们会看到打印信息为
Person(name=xiaoming, age=12, country=中国)
能把以上信息打印出来是因为Person类是个data calss 默认实现了toString方法
下面考虑这样一个问题,Person类中 name和age都是不可为null的,如果说json字符串中没有这两个字段会怎么样呢?我们来测试下
fun main(){
val json="{\"age\":12,\"country\":\"中国\"}"
val build = Moshi.Builder().build()
val adapter = build.adapter<Person>(Person::class.java)
val person = adapter.fromJson(json)
println(person)
}
执行以上代码控制台会输出错误
5.解析List<Person>
fun main(){
val json="[{\"name\":\"xiaoming\",\"age\":12,\"country\":\"中国\"},{\"name\":\"xiaoli\",\"age\":22,\"country\":\"美国\"}]"
val listOfPersonsType = Types.newParameterizedType(List::class.java,Person::class.java)
val build = Moshi.Builder().build()
val adapter = build.adapter<List<Person>>(listOfPersonsType)
val persons = adapter.fromJson(json)
println(persons)
}
6.@Json使用
如果数据和我们的bean字段不一样的话我们可以通过@Json(name=xxx) 来实现一一对应。
我们把name字段通过Json注解解析数据中的xingming字段。
@JsonClass(generateAdapter=true)
data class Person(@Json(name = "xingming")var name:String,var age:Int,var country:String="中国")
运行一下代码
fun main(){
val json="[{\"xingming\":\"xiaoming\",\"age\":12,\"country\":\"中国\"},{\"xingming\":\"xiaoli\",\"age\":22,\"country\":\"美国\"}]"
//通过Types.newParameterizedType来获取对应的类型
val listOfPersonsType = Types.newParameterizedType(List::class.java,Person::class.java)
val build = Moshi.Builder().build()
val adapter = build.adapter<List<Person>>(listOfPersonsType)
val persons = adapter.fromJson(json)
println(persons)
}
打印
[Person(name=xiaoming, age=12, country=中国), Person(name=xiaoli, age=22, country=美国)]
7.自定义Adapter,有时候返回的数据类型和我们的bean类型不一样。这个时候我们可以自定义adapter来解析对应数据,比如说boolean类型有的语言用1或者0来表示。
使用@FromJson 和@ToJson 注解
class BooleanAdapter {
@FromJson
fun fromJson(value:Int):Boolean{
return value !=0
}
@ToJson
fun toJson(value:Boolean):Int{
return if(value)1 else 0
}
}
Moshi创建的时候添加BooleanAdapter,会把字段名一样类型不一样的字段给翻译成正确的类型。
val build = Moshi.Builder().add(BooleanAdapter()).build()
以上就是Moshi的简单使用。