添加 Json操作类 及 单元测试

Author: UtilCore

readme.md

@@ -105,6 +105,8 @@ Util应用框架面向的是*架构初学者*，但不是.net初学者。
 
 对于简单的操作，你可以运行和阅读相应单元测试代码，即可了解它们如何使用。对于复杂操作，一方面看单元测试，另外我们会编写相关文档以描述调用方式和工作机制。
 
+Util暂时未发布到nuget，待成熟后发布。
+
 ## 开发环境
 
 以下是我们在项目开发和部署时使用的工具和组件，这个列表会经常更新。
@@ -199,7 +201,7 @@ Util应用框架技术顾问团队负责对API易用性，代码健壮性，设
 
 > 如果你在阅读或使用Util中任意一个代码片断时发现Bug，或有更佳实现方式，请通知我们。
 
-> 为了保持代码简单，目前很多代码只建立了一个基础结构，我在有需求的时候再添加特性，如果你发现无法满足你的需求，请通知我们。
+> 为了保持代码简单，目前很多功能只建立了基本结构，细节特性未进行迁移，在后续需要时进行添加，如果你发现某个类无法满足你的需求，请通知我们。
 
 > 你可以通过github的Issue或Pull Request向我们提交问题和代码，如果你更喜欢使用QQ进行交流，请加入我们的交流QQ群。
 
@@ -266,6 +268,10 @@ https://github.com/dotnetcore/util/
 
 ## 引用的第三方框架
 
+> 未指明版本号，将使用最新版本。
+
+- Newtonsoft.Json
+
 ## 更新计划
 
 > 不打算提供精确的更新计划，以免无法兑现。
@@ -274,7 +280,11 @@ https://github.com/dotnetcore/util/
 
 - 公共操作类(工具类)
   - 类型转换操作 [已发布]
+  - Json操作 - 基于Newtonsoft.Json [已发布]
+  - 对象映射操作 - 基于AutoMapper [已完成]
+  - Ioc操作 - 基于Autofac [已完成]
 
 ## 更新列表
 
-- 2017年7月6日，更新了类型转换操作类，类型转换扩展方法，类型转换单元测试。
+- 2017年7月6日，更新了类型转换操作类，类型转换扩展方法，类型转换单元测试。
+- 2017年7月14日，更新了Json操作类，Json操作单元测试。

src/Util/01-Util.csproj

@@ -5,11 +5,13 @@
     <AssemblyName>Util</AssemblyName>
     <RootNamespace>Util</RootNamespace>
     <Authors>何镇汐</Authors>
-    <Description>Utill应用框架</Description>
+    <Description>Utill应用框架核心库</Description>
     <Version>1.0.0</Version>
     <Product>Utill应用框架核心库</Product>
     <AssemblyVersion>1.0.0.0</AssemblyVersion>
     <FileVersion>1.0.0.0</FileVersion>
+    <Copyright>何镇汐</Copyright>
+    <PackageReleaseNotes>Util应用框架以MIT开源发布，可随意使用</PackageReleaseNotes>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">

src/Util/Helpers/Json.cs

@@ -0,0 +1,32 @@
+using Newtonsoft.Json;
+
+namespace Util.Helpers {
+    /// <summary>
+    /// Json操作
+    /// </summary>
+    public static class Json {
+        /// <summary>
+        /// 将Json字符串转换为对象
+        /// </summary>
+        /// <param name="json">Json字符串</param>
+        public static T ToObject<T>( string json ) {
+            if ( string.IsNullOrWhiteSpace( json ) )
+                return default(T);
+            return JsonConvert.DeserializeObject<T>( json );
+        }
+
+        /// <summary>
+        /// 将对象转换为Json字符串
+        /// </summary>
+        /// <param name="target">目标对象</param>
+        /// <param name="isConvertToSingleQuotes">是否将双引号转成单引号</param>
+        public static string ToJson( object target,bool isConvertToSingleQuotes = false ) {
+            if ( target == null )
+                return "{}";
+            var result = JsonConvert.SerializeObject( target );
+            if ( isConvertToSingleQuotes )
+                result = result.Replace( "\"", "'" );
+            return result;
+        }
+    }
+}

test/Util.Tests/Helpers/JsonTest.cs

@@ -0,0 +1,61 @@
+using System.Text;
+using Newtonsoft.Json;
+using Util.Helpers;
+using Util.Tests.Samples;
+using Util.Tests.XUnitHelpers;
+using Xunit;
+
+namespace Util.Tests.Helpers {
+    /// <summary>
+    /// Json测试
+    /// </summary>
+    public class JsonTest {
+        /// <summary>
+        /// 测试循环引用序列化
+        /// </summary>
+        [Fact]
+        public void TestLoop() {
+            A a = new A { Name = "a" };
+            B b = new B { Name = "b" };
+            C c = new C { Name = "c" };
+            a.B = b;
+            b.C = c;
+            c.A = a;
+            AssertHelper.Throws<JsonSerializationException>( () => Json.ToJson( c ) );
+        }
+
+        /// <summary>
+        /// 转成Json,验证空
+        /// </summary>
+        [Fact]
+        public void TestToJson_Null() {
+            Assert.Equal( "{}", Json.ToJson( null ) );
+        }
+
+        /// <summary>
+        /// 测试转成Json
+        /// </summary>
+        [Fact]
+        public void TestToJson() {
+            var result = new StringBuilder();
+            result.Append( "{" );
+            result.Append( "\"Name\":\"a\"," );
+            result.Append( "\"nickname\":\"b\"," );
+            result.Append( "\"Value\":null," );
+            result.Append( "\"Date\":\"2012/1/1 0:00:00\"," );
+            result.Append( "\"Age\":1," );
+            result.Append( "\"isShow\":true" );
+            result.Append( "}" );
+            Assert.Equal( result.ToString(), Json.ToJson( JsonTestSample.Create() ) );
+        }
+
+        /// <summary>
+        /// 测试转成对象
+        /// </summary>
+        [Fact]
+        public void TestToObject() {
+            var customer = Json.ToObject<JsonTestSample>( $"{{\"Name\":\"a\"}}" );
+            Assert.Equal( "a", customer.Name );
+        }
+    }
+}

test/Util.Tests/Samples/JsonTestSample.cs

@@ -0,0 +1,65 @@
+namespace Util.Tests.Samples {
+    public class A {
+        public string Name { get; set; }
+        public B B { get; set; }
+    }
+
+    public class B {
+        public string Name { get; set; }
+        public C C { get; set; }
+    }
+
+    public class C {
+        public string Name { get; set; }
+        public A A { get; set; }
+    }
+
+    /// <summary>
+    /// Json测试样例
+    /// </summary>
+    public class JsonTestSample {
+        /// <summary>
+        /// 名称,测试公共属性，且首字母大写
+        /// </summary>
+        public string Name { get; set; }
+        /// <summary>
+        /// 私有属性，应被忽略
+        /// </summary>
+        private string A { get; set; }
+        /// <summary>
+        /// 昵称，用来测试小写
+        /// </summary>
+        public string nickname { get; set; }
+        /// <summary>
+        /// 测试null
+        /// </summary>
+        public object Value { get; set; }
+        /// <summary>
+        /// 日期
+        /// </summary>
+        public string Date { get; set; }
+        /// <summary>
+        /// 测试整型，不添加引号
+        /// </summary>
+        public int Age { get; set; }
+        /// <summary>
+        /// 测试布尔型
+        /// </summary>
+        public bool isShow { get; set; }
+
+        /// <summary>
+        /// 创建客户
+        /// </summary>
+        public static JsonTestSample Create() {
+            return new JsonTestSample() {
+                Name = "a",
+                A = "1",
+                nickname = "b",
+                Value = null,
+                Date = Util.Helpers.Convert.ToDate( "2012-1-1" ).ToString(),
+                Age = 1,
+                isShow = true
+            };
+        }
+    }
+}

test/Util.Tests/XUnitHelpers/AssertHelper.cs

@@ -0,0 +1,22 @@
+using System;
+using Xunit;
+
+namespace Util.Tests.XUnitHelpers {
+    /// <summary>
+    /// 断言操作
+    /// </summary>
+    public class AssertHelper {
+        /// <summary>
+        /// 抛出异常，并从异常消息中搜索特定关键字
+        /// </summary>
+        /// <typeparam name="TException">异常类型</typeparam>
+        /// <param name="action">操作</param>
+        /// <param name="keyword">关键字</param>
+        public static TException Throws<TException>( Action action,string keyword = "" ) where TException : Exception {
+            var exception = Assert.Throws<TException>( action );
+            if( !string.IsNullOrWhiteSpace(keyword) )
+                Assert.Contains( keyword, exception.Message );
+            return exception;
+        }
+    }
+}