重构支付宝参数生成器

Author: UtilCore

build/version.props

@@ -3,7 +3,7 @@
 		<VersionMajor>1</VersionMajor>
 		<VersionMinor>0</VersionMinor>
 		<VersionPatch>11</VersionPatch>
-		<VersionQuality>20180522-1</VersionQuality>
+		<VersionQuality>20180523-1</VersionQuality>
 		<VersionPrefix>$(VersionMajor).$(VersionMinor).$(VersionPatch)</VersionPrefix>
 		<VersionSuffix>preview-$(VersionQuality)</VersionSuffix>
 	</PropertyGroup>

src/Util.Biz.Payments/Alipay/Configs/AlipayConfig.cs

@@ -36,14 +36,8 @@ public class AlipayConfig {
         /// <summary>
         /// 回调通知地址
         /// </summary>
-        [Required( ErrorMessage = "回调通知地址[NotifyUrl]不能为空" )]
         public string NotifyUrl { get; set; }
 
-        /// <summary>
-        /// 返回地址
-        /// </summary>
-        public string ReturnUrl { get; set; }
-
         /// <summary>
         /// 验证
         /// </summary>

src/Util.Biz.Payments/Alipay/Parameters/AlipayContentBuilder.cs

@@ -9,10 +9,12 @@ namespace Util.Biz.Payments.Alipay.Parameters {
     /// </summary>
     public class AlipayContentBuilder : ParameterBuilder {
         /// <summary>
-        /// 加载支付参数
+        /// 初始化支付参数
         /// </summary>
         /// <param name="param">支付参数</param>
-        public AlipayContentBuilder Load( PayParam param ) {
+        public AlipayContentBuilder Init( PayParamBase param ) {
+            if( param == null )
+                return this;
             return OutTradeNo( param.OrderId )
                 .Subject( param.Subject )
                 .TotalAmount( param.Money )

src/Util.Biz.Payments/Alipay/Parameters/AlipayParameterBuilder.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using Util.Biz.Payments.Alipay.Configs;
+using Util.Biz.Payments.Core;
 using Util.Helpers;
 using Util.Parameters;
 using Util.Signatures;
@@ -9,10 +10,6 @@ namespace Util.Biz.Payments.Alipay.Parameters {
     /// 支付宝参数生成器
     /// </summary>
     public class AlipayParameterBuilder {
-        /// <summary>
-        /// 配置
-        /// </summary>
-        private readonly AlipayConfig _config;
         /// <summary>
         /// 参数生成器
         /// </summary>
@@ -22,23 +19,35 @@ public class AlipayParameterBuilder {
         /// 初始化支付宝参数生成器
         /// </summary>
         /// <param name="config">配置</param>
-        public AlipayParameterBuilder( AlipayConfig config ) {
+        /// <param name="param">参数</param>
+        public AlipayParameterBuilder( AlipayConfig config, PayParamBase param = null ) {
             config.CheckNull( nameof( config ) );
-            _config = config;
+            Config = config;
             _builder = new UrlParameterBuilder();
-            InitConfig();
+            Content = new AlipayContentBuilder();
+            Init( param );
         }
 
         /// <summary>
         /// 配置
         /// </summary>
-        public AlipayConfig Config => _config;
+        public AlipayConfig Config { get; }
+
+        /// <summary>
+        /// 内容
+        /// </summary>
+        public AlipayContentBuilder Content { get; }
 
         /// <summary>
-        /// 初始化配置
+        /// 初始化
         /// </summary>
-        private void InitConfig() {
-            Format( "json" ).Charset( "utf-8" ).SignType( "RSA2" ).Timestamp().Version( "1.0" ).AppId( _config.AppId );
+        private void Init( PayParamBase param ) {
+            Format( "json" ).Charset( "utf-8" ).SignType( "RSA2" ).Timestamp().Version( "1.0" ).AppId( Config.AppId );
+            if( param == null )
+                return;
+            param.Init();
+            Content.Init( param );
+            ReturnUrl( param.ReturnUrl ).NotifyUrl( param.NotifyUrl );
         }
 
         /// <summary>
@@ -86,73 +95,85 @@ private AlipayParameterBuilder Version( string version ) {
         }
 
         /// <summary>
-        /// 设置应用Id
+        /// 设置应用标识
         /// </summary>
-        /// <param name="appId">应用Id</param>
+        /// <param name="appId">应用标识</param>
         public AlipayParameterBuilder AppId( string appId ) {
             _builder.Add( AlipayConst.AppId, appId );
             return this;
         }
 
         /// <summary>
-        /// 设置请求方法
+        /// 设置返回地址
         /// </summary>
-        /// <param name="method">请求方法</param>
-        public AlipayParameterBuilder Method( string method ) {
-            _builder.Add( AlipayConst.Method, method );
+        /// <param name="returnUrl">返回地址</param>
+        public AlipayParameterBuilder ReturnUrl( string returnUrl ) {
+            _builder.Add( AlipayConst.ReturnUrl, returnUrl );
             return this;
         }
 
         /// <summary>
-        /// 设置内容
+        /// 设置回调通知地址
         /// </summary>
-        /// <param name="content">内容</param>
-        public AlipayParameterBuilder Content( string content ) {
-            _builder.Add( AlipayConst.BizContent, content );
+        /// <param name="notifyUrl">回调通知地址</param>
+        public AlipayParameterBuilder NotifyUrl( string notifyUrl ) {
+            _builder.Add( AlipayConst.NotifyUrl, GetNotifyUrl( notifyUrl ) );
             return this;
         }
 
         /// <summary>
-        /// 设置内容
+        /// 获取回调通知地址
         /// </summary>
-        /// <param name="builder">内容参数生成器</param>
-        /// <param name="isConvertToSingleQuotes">是否将双引号转成单引号</param>
-        public AlipayParameterBuilder Content( AlipayContentBuilder builder, bool isConvertToSingleQuotes = false ) {
-            return Content( builder.ToJson( isConvertToSingleQuotes ) );
+        private string GetNotifyUrl( string notifyUrl ) {
+            if( notifyUrl.IsEmpty() )
+                return Config.NotifyUrl;
+            return notifyUrl;
+        }
+
+        /// <summary>
+        /// 设置请求方法
+        /// </summary>
+        /// <param name="method">请求方法</param>
+        public AlipayParameterBuilder Method( string method ) {
+            _builder.Add( AlipayConst.Method, method );
+            return this;
+        }
+
+        /// <summary>
+        /// 获取值
+        /// </summary>
+        /// <param name="name">参数名</param>
+        public string GetValue( string name ) {
+            return _builder.GetValue( name );
         }
 
         /// <summary>
         /// 获取参数字典
         /// </summary>
-        public IDictionary<string, string> GetDictionary() {
-            return GetSignBuilder().GetDictionary();
+        /// <param name="isConvertToSingleQuotes">是否将双引号转成单引号</param>
+        public IDictionary<string, string> GetDictionary( bool isConvertToSingleQuotes = false ) {
+            return GetSignBuilder( isConvertToSingleQuotes ).GetDictionary();
         }
 
         /// <summary>
         /// 获取签名的参数生成器
         /// </summary>
-        private UrlParameterBuilder GetSignBuilder() {
+        private UrlParameterBuilder GetSignBuilder( bool isConvertToSingleQuotes = false ) {
             var builder = new UrlParameterBuilder( _builder );
-            builder.Add( AlipayConst.Sign, GetSign() );
+            if( Content.IsEmpty == false )
+                builder.Add( AlipayConst.BizContent, Content.ToJson( isConvertToSingleQuotes ) );
+            builder.Add( AlipayConst.Sign, GetSign( builder ) );
             return builder;
         }
 
         /// <summary>
         /// 获取签名
         /// </summary>
-        private string GetSign() {
-            var signManager = new SignManager( new SignKey( _config.AppPrivateKey ), _builder );
+        private string GetSign( UrlParameterBuilder builder ) {
+            var signManager = new SignManager( new SignKey( Config.AppPrivateKey ), builder );
             return signManager.Sign();
         }
 
-        /// <summary>
-        /// 获取值
-        /// </summary>
-        /// <param name="name">参数名</param>
-        public string GetValue( string name ) {
-            return _builder.GetValue( name );
-        }
-
         /// <summary>
         /// 输出结果
         /// </summary>

src/Util.Biz.Payments/Alipay/Parameters/FormBuilder.cs

@@ -95,7 +95,7 @@ private void AddProperties( AlipayParameterBuilder builder ) {
         /// 添加input列表
         /// </summary>
         private void AddInputs( AlipayParameterBuilder builder ) {
-            foreach( var item in builder.GetDictionary() )
+            foreach( var item in builder.GetDictionary( true ) )
                 AddInput( item.Key, item.Value );
         }
 
@@ -123,7 +123,7 @@ private TagBuilder CreateSubmitButton() {
         public string Result() {
             using( var writer = new StringWriter() ) {
                 _builder.WriteTo( writer, NullHtmlEncoder.Default );
-                if ( IsAutoSubmit ) {
+                if( IsAutoSubmit ) {
                     var scriptBuilder = CreateScript();
                     scriptBuilder.WriteTo( writer, NullHtmlEncoder.Default );
                 }

src/Util.Biz.Payments/Alipay/Services/AlipayPagePayService.cs

@@ -25,9 +25,9 @@ public AlipayPagePayService( IAlipayConfigProvider provider ) : base( provider )
         /// <param name="param">支付参数</param>
         public override async Task<PayResult> PayAsync( PayParam param ) {
             var config = await ConfigProvider.GetConfigAsync();
-            Validate( param, config );
-            var builder = new AlipayParameterBuilder( config );
-            Config( param, builder, true );
+            Validate( config, param );
+            var builder = new AlipayParameterBuilder( config, param );
+            Config( builder, param );
             var form = GetForm( builder );
             WriteLog( config, builder, form );
             return new PayResult { Result = form };

src/Util.Biz.Payments/Alipay/Services/AlipayServiceBase.cs

@@ -36,16 +36,16 @@ protected AlipayServiceBase( IAlipayConfigProvider provider ) {
         /// <param name="param">支付参数</param>
         public virtual async Task<PayResult> PayAsync( PayParam param ) {
             var config = await ConfigProvider.GetConfigAsync();
-            Validate( param, config );
-            var builder = new AlipayParameterBuilder( config );
-            Config( param, builder );
+            Validate( config, param );
+            var builder = new AlipayParameterBuilder( config, param );
+            Config( builder, param );
             return await RequstResult( config, builder );
         }
 
         /// <summary>
         /// 验证
         /// </summary>
-        protected void Validate( PayParam param, AlipayConfig config ) {
+        protected void Validate( AlipayConfig config, PayParam param ) {
             param.CheckNull( nameof( param ) );
             config.CheckNull( nameof( config ) );
             param.Validate();
@@ -61,34 +61,20 @@ protected virtual void ValidateParam( PayParam param ) {
         }
 
         /// <summary>
-        /// 参数配置
+        /// 配置
         /// </summary>
-        /// <param name="param">支付参数</param>
         /// <param name="builder">支付宝参数生成器</param>
-        /// <param name="isConvertToSingleQuotes">是否将双引号转成单引号</param>
-        protected void Config( PayParam param, AlipayParameterBuilder builder, bool isConvertToSingleQuotes = false ) {
-            param.Init();
-            var contentBuilder = CreateContentBuilder( param ).Scene( GetScene() );
-            InitContentBuilder( contentBuilder, param );
-            builder.Content( contentBuilder, isConvertToSingleQuotes ).Method( GetMethod() );
-        }
-
-        /// <summary>
-        /// 获取内容参数生成器
-        /// </summary>
-        protected AlipayContentBuilder CreateContentBuilder( PayParam param ) {
-            var builder = new AlipayContentBuilder();
-            builder.Load( param );
-            return builder;
+        /// <param name="param">支付参数</param>
+        protected void Config( AlipayParameterBuilder builder, PayParam param ) {
+            builder.Method( GetMethod() );
+            builder.Content.Scene( GetScene() );
+            InitContentBuilder( builder.Content, param );
         }
 
         /// <summary>
-        /// 初始化内容生成器
+        /// 获取请求方法
         /// </summary>
-        /// <param name="builder">内容参数生成器</param>
-        /// <param name="param">支付参数</param>
-        protected virtual void InitContentBuilder( AlipayContentBuilder builder, PayParam param ) {
-        }
+        protected abstract string GetMethod();
 
         /// <summary>
         /// 获取场景
@@ -98,9 +84,12 @@ protected virtual string GetScene() {
         }
 
         /// <summary>
-        /// 获取请求方法
+        /// 初始化内容生成器
         /// </summary>
-        protected abstract string GetMethod();
+        /// <param name="builder">内容参数生成器</param>
+        /// <param name="param">支付参数</param>
+        protected virtual void InitContentBuilder( AlipayContentBuilder builder, PayParam param ) {
+        }
 
         /// <summary>
         /// 请求结果
@@ -139,7 +128,6 @@ protected void WriteLog( AlipayConfig config, AlipayParameterBuilder builder, Al
                 .Caption( "支付宝支付" )
                 .Content( $"支付方式 : {GetPayWay().Description()}" )
                 .Content( $"支付网关 : {config.GatewayUrl}" )
-                .Content()
                 .Content( "请求参数:" )
                 .Content( builder.GetDictionary() )
                 .Content()
@@ -157,17 +145,17 @@ protected void WriteLog( AlipayConfig config, AlipayParameterBuilder builder, Al
         /// <summary>
         /// 写日志
         /// </summary>
-        protected void WriteLog( AlipayConfig config, AlipayParameterBuilder builder,string content ) {
+        protected void WriteLog( AlipayConfig config, AlipayParameterBuilder builder, string content ) {
             var log = GetLog();
             if( log.IsTraceEnabled == false )
                 return;
             log.Class( GetType().FullName )
                 .Caption( "支付宝支付" )
                 .Content( $"支付方式 : {GetPayWay().Description()}" )
                 .Content( $"支付网关 : {config.GatewayUrl}" )
-                .Content()
                 .Content( "请求参数:" )
                 .Content( builder.GetDictionary() )
+                .Content()
                 .Content( "原始请求:" )
                 .Content( builder.ToString() )
                 .Content()
@@ -208,9 +196,9 @@ protected virtual PayResult CreateResult( AlipayResult result ) {
         /// <param name="param">支付参数</param>
         public virtual async Task<string> Debug( PayParam param ) {
             var config = await ConfigProvider.GetConfigAsync();
-            Validate( param, config );
-            var builder = new AlipayParameterBuilder( config );
-            Config( param, builder );
+            Validate( config, param );
+            var builder = new AlipayParameterBuilder( config, param );
+            Config( builder, param );
             return builder.ToString();
         }
     }

src/Util.Biz.Payments/Alipay/Services/AlipayWapPayService.cs

@@ -25,9 +25,9 @@ public AlipayWapPayService( IAlipayConfigProvider provider ) : base( provider )
         /// <param name="param">支付参数</param>
         public override async Task<PayResult> PayAsync( PayParam param ) {
             var config = await ConfigProvider.GetConfigAsync();
-            Validate( param, config );
-            var builder = new AlipayParameterBuilder( config );
-            Config( param, builder, true );
+            Validate( config, param );
+            var builder = new AlipayParameterBuilder( config, param );
+            Config( builder, param );
             var form = GetForm( builder );
             WriteLog( config, builder, form );
             return new PayResult { Result = form };

src/Util.Biz.Payments/Core/PayParamBase.cs

@@ -26,6 +26,14 @@ public class PayParamBase : IValidation {
         /// 支付订单付款超时时间，单位：分钟，默认为90分钟
         /// </summary>
         public int Timeout { get; set; } = 90;
+        /// <summary>
+        /// 返回地址
+        /// </summary>
+        public string ReturnUrl { get; set; }
+        /// <summary>
+        /// 回调通知地址
+        /// </summary>
+        public string NotifyUrl { get; set; }
 
         /// <summary>
         /// 初始化

src/Util.Biz.Payments/Factories/PayFactory.cs

@@ -1,5 +1,4 @@
 using System;
-using Util.Biz.Payments.Alipay;
 using Util.Biz.Payments.Alipay.Abstractions;
 using Util.Biz.Payments.Alipay.Configs;
 using Util.Biz.Payments.Alipay.Services;