跳到正文

Fast.Serialization.Newtonsoft.Json 公开 API ​

目标 net8.0;net9.0;net10.0。从本页目录选择类型,查看其声明和成员。配置、运行示例和边界见模块用法。

参考版本 3.5.28。源码提交 a8bd407bf5f6b811da7fb7bd1db827f4da119a94。

Fast.Serialization.JsonContext ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static class JsonContext

Newtonsoft.Json 序列化上下文

Fast.Serialization.JsonContext.SerializerOptions ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static JsonSerializerSettings SerializerOptions { get; internal set; }

Newtonsoft.Json 序列化选项

Fast.Serialization.IMvcBuilderExtension ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static class IMvcBuilderExtension

为 IMvcBuilder 提供 Newtonsoft.Json 扩展方法

Fast.Serialization.IMvcBuilderExtension.AddSerialization ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static IMvcBuilder AddSerialization(this IMvcBuilder builder)

添加 Newtonsoft.Json 序列化服务

  • 参数 builder:要配置的应用构建器
  • 返回:返回当前 MVC 构建器,便于链式调用

Fast.Serialization.IServiceCollectionExtension ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static class IServiceCollectionExtension

为 IServiceCollection 提供 Newtonsoft.Json 扩展方法

Fast.Serialization.IServiceCollectionExtension.AddSerialization ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static IServiceCollection AddSerialization(this IServiceCollection services,
        Action<MvcNewtonsoftJsonOptions> configureOptions = null)

添加 Newtonsoft.Json 序列化服务

  • 参数 services:要添加服务的服务集合
  • 参数 configureOptions:JSON 配置操作
  • 返回:返回 services,便于链式调用

Fast.Serialization.SerializationExtension ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static class SerializationExtension

提供 Newtonsoft.Json 扩展方法

Fast.Serialization.SerializationExtension.ToObject ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static T ToObject<T>(this string json)

将 JSON 文本反序列化为对象

  • 参数 json:要解析的 JSON 文本
  • 类型参数 T:序列化或转换后的对象类型
  • 返回:转换得到的对象

Fast.Serialization.SerializationExtension.ToObject ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static object ToObject(this string json, Type type)

将 JSON 文本反序列化为对象

  • 参数 json:要解析的 JSON 文本
  • 参数 type:目标类型
  • 返回:转换得到的对象

Fast.Serialization.SerializationExtension.ToJsonString ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static string ToJsonString(this object obj)

将对象序列化为 JSON 文本

  • 参数 obj:要处理的对象
  • 返回:序列化后的 JSON 文本

Fast.Serialization.SerializationExtension.ToObject ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static T ToObject<T>(this IDictionary<string, object> dictionary)

将字典数据转换为对象

  • 参数 dictionary:要处理的字典
  • 类型参数 T:序列化或转换后的对象类型
  • 返回:转换得到的对象

Fast.Serialization.SerializationExtension.ToObject ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static object ToObject(this IDictionary<string, object> dictionary, Type type)

将字典数据转换为对象

  • 参数 dictionary:要处理的字典
  • 参数 type:目标类型
  • 返回:转换得到的对象

Fast.Serialization.SerializationExtension.DeepCopy ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public static T DeepCopy<T>(this T source)

通过 JSON 序列化创建对象的深层副本

说明:该方法通过一次序列化和反序列化创建副本,开销高于成员复制,且只保留可序列化的数据

  • 参数 source:需要拷贝的对象
  • 类型参数 T:要复制的对象类型
  • 返回:创建的对象副本

Fast.Serialization.DataMaskingTypeEnum ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public enum DataMaskingTypeEnum

数据脱敏类型枚举

Fast.Serialization.DataMaskingTypeEnum.Name ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
Name

姓名

Fast.Serialization.DataMaskingTypeEnum.NameKeepLast ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
NameKeepLast

姓名(保留首尾)

Fast.Serialization.DataMaskingTypeEnum.Account ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
Account

账号

Fast.Serialization.DataMaskingTypeEnum.Mobile ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
Mobile

手机号

Fast.Serialization.DataMaskingTypeEnum.IdCard ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
IdCard

身份证

Fast.Serialization.DataMaskingTypeEnum.Email ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
Email

邮箱

Fast.Serialization.DataMaskingTypeEnum.BankCard ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
BankCard

银行卡

Fast.Serialization.DataMaskingTypeEnum.Address ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
Address

地址

Fast.Serialization.DataMaskingTypeEnum.CarNumber ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
CarNumber

车牌号

Fast.Serialization.DataMaskingTypeEnum.Ip ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
Ip

IP 地址

Fast.Serialization.DataMaskingConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public class DataMaskingConverter : JsonConverter<string>

JSON 返回数据脱敏处理

Fast.Serialization.DataMaskingConverter.MaskingType ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public DataMaskingTypeEnum MaskingType { get; set; }

数据脱敏类型

Fast.Serialization.DataMaskingConverter.DataMaskingConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public DataMaskingConverter(DataMaskingTypeEnum maskingType)

JSON 返回数据脱敏处理

  • 参数 maskingType:数据脱敏方式

Fast.Serialization.DataMaskingConverter.WriteJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override void WriteJson(JsonWriter writer, string value, JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。

Fast.Serialization.DataMaskingConverter.ReadJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override string ReadJson(JsonReader reader, Type objectType, string existingValue, bool hasExistingValue,
        JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。

Fast.Serialization.DateJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public class DateJsonConverter : JsonConverter<DateTime>

DateTime 类型 JSON 返回日期处理

Fast.Serialization.DateJsonConverter.Format ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public string Format { get; set; }

日期格式化 默认:yyyy-MM-dd

Fast.Serialization.DateJsonConverter.DateJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public DateJsonConverter()

DateTime 类型 JSON 返回日期处理

Fast.Serialization.DateJsonConverter.DateJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public DateJsonConverter(string format)

DateTime 类型 JSON 返回日期处理

  • 参数 format:日期格式化 默认:yyyy-MM-dd

Fast.Serialization.DateJsonConverter.WriteJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override void WriteJson(JsonWriter writer, DateTime value, JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。

Fast.Serialization.DateJsonConverter.ReadJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override DateTime ReadJson(JsonReader reader, Type objectType, DateTime existingValue, bool hasExistingValue,
        JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。

Fast.Serialization.NullableDateJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public class NullableDateJsonConverter : JsonConverter<DateTime?>

DateTime? 类型 JSON 返回日期处理

Fast.Serialization.NullableDateJsonConverter.Format ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public string Format { get; set; }

日期格式化 默认:yyyy-MM-dd

Fast.Serialization.NullableDateJsonConverter.NullableDateJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public NullableDateJsonConverter()

DateTime? 类型 JSON 返回日期处理

Fast.Serialization.NullableDateJsonConverter.NullableDateJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public NullableDateJsonConverter(string format)

DateTime? 类型 JSON 返回日期处理

  • 参数 format:日期格式化 默认:yyyy-MM-dd

Fast.Serialization.NullableDateJsonConverter.WriteJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override void WriteJson(JsonWriter writer, DateTime? value, JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。

Fast.Serialization.NullableDateJsonConverter.ReadJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override DateTime? ReadJson(JsonReader reader, Type objectType, DateTime? existingValue, bool hasExistingValue,
        JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。

Fast.Serialization.TimeJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public class TimeJsonConverter : JsonConverter<DateTime>

DateTime 类型 JSON 返回时间处理

Fast.Serialization.TimeJsonConverter.Format ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public string Format { get; set; }

日期格式化 默认:HH:mm:ss

Fast.Serialization.TimeJsonConverter.TimeJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public TimeJsonConverter()

DateTime 类型 JSON 返回时间处理

Fast.Serialization.TimeJsonConverter.TimeJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public TimeJsonConverter(string format)

DateTime 类型 JSON 返回时间处理

  • 参数 format:日期格式化 默认:HH:mm:ss

Fast.Serialization.TimeJsonConverter.WriteJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override void WriteJson(JsonWriter writer, DateTime value, JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。

Fast.Serialization.TimeJsonConverter.ReadJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override DateTime ReadJson(JsonReader reader, Type objectType, DateTime existingValue, bool hasExistingValue,
        JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。

Fast.Serialization.NullableTimeJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public class NullableTimeJsonConverter : JsonConverter<DateTime?>

DateTime? 类型 JSON 返回时间处理

Fast.Serialization.NullableTimeJsonConverter.Format ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public string Format { get; set; }

日期格式化 默认:HH:mm:ss

Fast.Serialization.NullableTimeJsonConverter.NullableTimeJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public NullableTimeJsonConverter()

DateTime? 类型 JSON 返回时间处理

Fast.Serialization.NullableTimeJsonConverter.NullableTimeJsonConverter ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public NullableTimeJsonConverter(string format)

DateTime? 类型 JSON 返回时间处理

  • 参数 format:日期格式化 默认:HH:mm:ss

Fast.Serialization.NullableTimeJsonConverter.WriteJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override void WriteJson(JsonWriter writer, DateTime? value, JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。

Fast.Serialization.NullableTimeJsonConverter.ReadJson ​

源码 · 目标:net8.0、net9.0、net10.0

csharp
public override DateTime? ReadJson(JsonReader reader, Type objectType, DateTime? existingValue, bool hasExistingValue,
        JsonSerializer serializer)

说明继承自接口或基类,需结合对应声明阅读。