nopCommerce 3.9 大波浪系列 之 可退款的支付宝插件（下）

一.回顾

支付宝插件源码下载地址：点击下载      

    上篇介绍了使用支付宝插件进行支付，全额退款，部分退款还有插件的多店铺配置，本文介绍下如何实现的。

二.前期准备

    插件主要有3个功能：

1. 多店铺插件配置 
2. 支付功能
3. 退款功能

   数据库支持：

1. 新增dbl_PaymentInfo表保存支付记录。
2. 新增dbl_RefundInfo表保存退款记录。

   其他准备：

1. 支付宝即时到账PID和MD5秘钥Key，可通过支付宝开放平台获取。

三.流程规划 

1. 插件安装卸载流程

   2.  支付流程

   3.  退款流程

四.创建项目

    1.  新建类库项目，名称为 DaBoLang.Nop.Plugin.Payments.AliPay，位置放在Plugins下

    2.  点击项目快捷键Alt+Enter进入项目属性，

         设置输出路径为..\..\Presentation\Nop.Web\Plugins\DaBoLang.Payments.AliPay\

    3.  安装相关包：项目根目录新建packages.config文件，内容如下

<?xml version="1.0" encoding="utf-8"?>
<packages>
  <package id="Autofac" version="4.4.0" targetFramework="net451" />
  <package id="Microsoft.AspNet.Mvc" version="5.2.3" targetFramework="net451" />
  <package id="Microsoft.AspNet.Razor" version="3.2.3" targetFramework="net451" />
  <package id="Microsoft.AspNet.WebPages" version="3.2.3" targetFramework="net451" />
  <package id="Microsoft.Web.Infrastructure" version="1.0.0.0" targetFramework="net451" />
</packages>

      打开【工具】【NuGet 包管理器】【程序包管理器控制台】，

      输入下边命令更新包: Update-Package -ProjectName 'DaBoLang.Nop.Plugin.Payments.AliPay'  -Reinstall

      最后添加 Nop.Core  Nop.Data   Nop.Services  Nop.Web.FrameWork 项目引用

    4.  创建插件描述文件：根目录新建Description.txt文件 用于插件描述，写入内容如下：

Group: Payment methods
FriendlyName: 支付宝
SystemName: DaBoLang.Payments.AliPay
Version: 1.00
SupportedVersions: 3.90
Author: 大波浪
DisplayOrder: 1
FileName: DaBoLang.Nop.Plugin.Payments.AliPay.dll
Description: 支付宝 即时到账 插件,支持支付,退款

    5. 创建项目目录，如果你已经下载了插件项目参考项目目录如下：

• Alipay  支付宝即时到账相关
• Controllers 控制器文件夹
• Data    数据库相关
• Domain 实体类
• Models  模型
• Services  服务接口
• Views  视图
• AliPayPaymentProcessor.cs   支付插件实现类
• AliPayPaymentSettings.cs     支付宝即时到账配置类
• DependencyRegistrar.cs     依赖注入扩展类
• Description.txt   插件描述文件
• RouteProvider.cs    路由注册类

五.创建数据库

     项目我们已经创建好了。记下来我们创建付款记录表和退款记录表用于保存相关记录。nop使用的是ORM框架为Entity Framework框架，我们使用Code First模式来创建。

    1.  在Domain文件夹创建PaymentInfo类用于保存付款信息，RefundInfo类用于保存退款信息。

nop中的实体类需要继承 Nop.Core.BaseEntity 抽象方法。

using Nop.Core;
using Nop.Core.Domain.Customers;
using Nop.Core.Domain.Orders;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.Linq;

namespace DaBoLang.Nop.Plugin.Payments.AliPay.Domain
{
    /// <summary>
    /// 命名空间：DaBoLang.Nop.Plugin.Payments.AliPay.Domain
    /// 名    称：PaymentInfo
    /// 功    能：实体类
    /// 详    细：付款记录
    /// 版    本：1.0.0.0 
    /// 作    者：大波浪
    /// 联系方式：http://www.cnblogs.com/yaoshangjin
    /// 说    明：
    /// </summary>
    public partial class PaymentInfo : BaseEntity
    {
        #region Properties
        public Guid PaymentGuid { get; set; }
        /// <summary>
        /// 订单编号
        /// </summary>
        public int OrderId { get; set; }
        /// <summary>
        /// 插件SystemName
        /// </summary>
        public string Name { get; set; }
        /// <summary>
        /// 交易金额
        /// </summary>
        public decimal Total { get; set; }
        /// <summary>
        /// 订单编号外部交易号
        /// </summary>
        public string Out_Trade_No { get; set; }
        /// <summary>
        /// 说明
        /// </summary>
        public string Note { get; set; }
        /// <summary>
        /// 交易号，内部交易号，支付宝交易号或者微信交易号
        /// </summary>
        public string Trade_no { get; set; }
        /// <summary>
        /// 第三方交易状态
        /// </summary>
        public string Trade_status { get; set; }
        /// <summary>
        /// 收款单位email
        /// </summary>
        public string Seller_email { get; set; }
        /// <summary>
        /// 收款单位id
        /// </summary>
        public string Seller_id { get; set; }
        /// <summary>
        /// 付款账户id
        /// </summary>
        public string Buyer_id { get; set; }
        /// <summary>
        /// 付款账户email
        /// </summary>
        public string Buyer_email { get; set; }
       /// <summary>
       /// 内部订单创建时间
       /// </summary>
        public DateTime CreateDateUtc { get; set; }

        #endregion
    }
}

using Nop.Core;
using Nop.Core.Domain.Customers;
using Nop.Core.Domain.Orders;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.Linq;

namespace DaBoLang.Nop.Plugin.Payments.AliPay.Domain
{
    /// <summary>
    /// 命名空间：DaBoLang.Nop.Plugin.Payments.AliPay.Domain
    /// 名    称：RefundInfo
    /// 功    能：实体类
    /// 详    细：退款记录
    /// 版    本：1.0.0.0
    /// 作    者：大波浪
    /// 联系方式：http://www.cnblogs.com/yaoshangjin
    /// 说    明：
    /// </summary>
    public partial class RefundInfo : BaseEntity
    {

        #region Properties
        public int OrderId { get; set; }
        /// <summary>
        /// 退款状态
        /// </summary>
        public int RefundStatusId { get; set; }
        /// <summary>
        /// 退款金额
        /// </summary>
        public decimal AmountToRefund { get; set; }
        public string Seller_Email { get; set; }
        public string Seller_Id { get; set; }
        /// <summary>
        /// 交易号，内部交易号，支付宝交易号或者微信交易号
        /// </summary>
        public string Batch_no { get; set; }
        /// <summary>
        /// 订单标号外部交易号
        /// </summary>
        public string Out_Trade_No { get; set; }
        /// <summary>
        /// 创建时间
        /// </summary>
        public DateTime CreateOnUtc { get; set; }
        /// <summary>
        /// 退款成功时间
        /// </summary>
        public DateTime? RefundOnUtc { get; set; }

        /// <summary>
        /// 回调ID
        /// </summary>
        public string Notify_Id { get; set; }
        /// <summary>
        /// 回调类型
        /// </summary>
        public string Notify_Type { get; set; }

        public string Result_Details { get; set; }
        #endregion

        /// <summary>
        /// 订单状态
        /// </summary>
        public RefundStatus RefundStatus
        {
            get
            {
                return (RefundStatus)this.RefundStatusId;
            }
            set
            {
                this.RefundStatusId = (int)value;
            }
        }

    }
    public enum RefundStatus
    {
        /// <summary>
        /// 申请退款
        /// </summary>
        refunding = 10,
        /// <summary>
        /// 退款成功
        /// </summary>
        refund = 20,
        /// <summary>
        /// 取消退款
        /// </summary>
        cancel = 30,
        /// <summary>
        /// 退款过期
        /// </summary>
        overtime = 40,
        /// <summary>
        /// 退款失败
        /// </summary>
        error = 50,
    }
}

    2.  Data文件夹中创建实体与数据库的映射关系配置

nop中映射关系配置需要继承  Nop.Data.Mapping.NopEntityTypeConfiguration<T> 接口，T泛型为映射的实体类 

该接口也是继承EntityTypeConfiguration<T>接口的    

    PaymentInfoMap类关联PaymentInfo实体类，

    构造函数中通过this.ToTable("dbl_PaymentInfo")指定数据库表明，this.HasKey(x => x.Id);指定主键

using DaBoLang.Nop.Plugin.Payments.AliPay.Domain;
using Nop.Data.Mapping;

namespace DaBoLang.Nop.Plugin.Payments.AliPay.Data
{
    /// <summary>
    /// 命名空间：DaBoLang.Nop.Plugin.Payments.AliPay.Data
    /// 名    称：PaymentInfoMap
    /// 功    能：实体映射
    /// 详    细：支付表映射
    /// 作    者：大波浪
    /// </summary>
    public partial class PaymentInfoMap : NopEntityTypeConfiguration<PaymentInfo>
    {
        public PaymentInfoMap()
        {
            this.ToTable("dbl_PaymentInfo");
            this.HasKey(x => x.Id);
        }
    }
}

      RefundInfoMap则将RefundInfo实体类与dbl_RefundInfo表进行关联。

      this.Ignore(x=>x.RefundStatus); 表示忽略RefundStatus属性，忽略的属性在创建数据时不会创建该属性字段。

using DaBoLang.Nop.Plugin.Payments.AliPay.Domain;
using Nop.Data.Mapping;

namespace DaBoLang.Nop.Plugin.Payments.AliPay.Data
{
    /// <summary>
    /// 命名空间：DaBoLang.Nop.Plugin.Payments.AliPay.Data
    /// 名    称：RefundInfoMap
    /// 功    能：实体映射
    /// 详    细：退款记录映射
    /// </summary>
    public partial class RefundInfoMap : NopEntityTypeConfiguration<RefundInfo>
    {
        public RefundInfoMap()
        {
            this.ToTable("dbl_RefundInfo");
            this.HasKey(x => x.Id);
            this.Ignore(x=>x.RefundStatus);
        }
    }
}

   3.  创建数据库上下文

       我们已经创建好2个表的实体类和映射关系，接下来我们需要创建DbContext数据库上下文。

       在Data目录下创建 AliPayObjectContext类，继承DbContext类和Nop.Data.IDbContext接口

重写OnModelCreating方法，将Map配置添加到EF中，

提示：Nop.Data.NopObjectContext是Nop默认上下文可供，这里也可以使用反射机制自动添加配置，当然需要再提取一次Map接口，有兴趣的朋友自行扩展。

 protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            modelBuilder.Configurations.Add(new PaymentInfoMap());
            modelBuilder.Configurations.Add(new RefundInfoMap());

            //disable EdmMetadata generation
            //modelBuilder.Conventions.Remove<IncludeMetadataConvention>();
            base.OnModelCreating(modelBuilder);
        }

添加Install()方法创建表，Uninstall()方法删除表。

       /// <summary>
        /// 安装
        /// </summary>
        public void Install()
        {
            //创建表
            var dbScript = CreateDatabaseScript();
            Database.ExecuteSqlCommand(dbScript);
            SaveChanges();
        }

        /// <summary>
        /// 卸载
        /// </summary>
        public void Uninstall()
        {
            //删除表
            var tableName = this.GetTableName<PaymentInfo>();
            this.DropPluginTable(tableName);
            tableName = this.GetTableName<RefundInfo>();
            this.DropPluginTable(tableName);
        }

完整的代码如下

using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Data.Entity.Infrastructure;
using Nop.Core;
using Nop.Data;
using DaBoLang.Nop.Plugin.Payments.AliPay.Domain;

namespace DaBoLang.Nop.Plugin.Payments.AliPay.Data
{
    /// <summary>
    /// 命名空间：DaBoLang.Nop.Plugin.Payments.AliPay.Data
    /// 名    称：AliPayObjectContext
    /// 功    能：数据库
    /// 详    细：数据库上下文
    /// 版    本：1.0.0.0
    /// 文件名称：AliPayObjectContext.cs
    /// 作    者：大波浪
    /// 联系方式：http://www.cnblogs.com/yaoshangjin
    /// 说    明：
    /// </summary>
    public class AliPayObjectContext : DbContext, IDbContext
    {
        #region Ctor

        public AliPayObjectContext(string nameOrConnectionString)
            : base(nameOrConnectionString)
        {
            //((IObjectContextAdapter) this).ObjectContext.ContextOptions.LazyLoadingEnabled = true;
        }

        #endregion

        #region Utilities

        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            modelBuilder.Configurations.Add(new PaymentInfoMap());
            modelBuilder.Configurations.Add(new RefundInfoMap());

            //disable EdmMetadata generation
            //modelBuilder.Conventions.Remove<IncludeMetadataConvention>();
            base.OnModelCreating(modelBuilder);
        }

        #endregion

        #region Methods

        public string CreateDatabaseScript()
        {
            return ((IObjectContextAdapter)this).ObjectContext.CreateDatabaseScript();
        }

        public new IDbSet<TEntity> Set<TEntity>() where TEntity : BaseEntity
        {
            return base.Set<TEntity>();
        }

        /// <summary>
        /// 安装
        /// </summary>
        public void Install()
        {
            //create the table
            var dbScript = CreateDatabaseScript();
            Database.ExecuteSqlCommand(dbScript);
            SaveChanges();
        }

        /// <summary>
        /// 卸载
        /// </summary>
        public void Uninstall()
        {
            //删除表
            var tableName = this.GetTableName<PaymentInfo>();
            this.DropPluginTable(tableName);
            tableName = this.GetTableName<RefundInfo>();
            this.DropPluginTable(tableName);
        }

        /// <summary>
        /// Execute stores procedure and load a list of entities at the end
        /// </summary>
        /// <typeparam name="TEntity">Entity type</typeparam>
        /// <param name="commandText">Command text</param>
        /// <param name="parameters">Parameters</param>
        /// <returns>Entities</returns>
        public IList<TEntity> ExecuteStoredProcedureList<TEntity>(string commandText, params object[] parameters) where TEntity : BaseEntity, new()
        {
            throw new NotImplementedException();
        }

        /// <summary>
        /// Creates a raw SQL query that will return elements of the given generic type.  The type can be any type that has properties that match the names of the columns returned from the query, or can be a simple primitive type. The type does not have to be an entity type. The results of this query are never tracked by the context even if the type of object returned is an entity type.
        /// </summary>
        /// <typeparam name="TElement">The type of object returned by the query.</typeparam>
        /// <param name="sql">The SQL query string.</param>
        /// <param name="parameters">The parameters to apply to the SQL query string.</param>
        /// <returns>Result</returns>
        public IEnumerable<TElement> SqlQuery<TElement>(string sql, params object[] parameters)
        {
            throw new NotImplementedException();
        }

        /// <summary>
        /// Executes the given DDL/DML command against the database.
        /// </summary>
        /// <param name="sql">The command string</param>
        /// <param name="doNotEnsureTransaction">false - the transaction creation is not ensured; true - the transaction creation is ensured.</param>
        /// <param name="timeout">Timeout value, in seconds. A null value indicates that the default value of the underlying provider will be used</param>
        /// <param name="parameters">The parameters to apply to the command string.</param>
        /// <returns>The result returned by the database after executing the command.</returns>
        public int ExecuteSqlCommand(string sql, bool doNotEnsureTransaction = false, int? timeout = null, params object[] parameters)
        {
            throw new NotImplementedException();
        }

        /// <summary>
        /// Detach an entity
        /// </summary>
        /// <param name="entity">Entity</param>
        public void Detach(object entity)
        {
            if (entity == null)
                throw new ArgumentNullException("entity");

            ((IObjectContextAdapter)this).ObjectContext.Detach(entity);
        }

        #endregion

        #region Properties

        /// <summary>
        /// Gets or sets a value indicating whether proxy creation setting is enabled (used in EF)
        /// </summary>
        public virtual bool ProxyCreationEnabled
        {
            get
            {
                return this.Configuration.ProxyCreationEnabled;
            }
            set
            {
                this.Configuration.ProxyCreationEnabled = value;
            }
        }

        /// <summary>
        /// Gets or sets a value indicating whether auto detect changes setting is enabled (used in EF)
        /// </summary>
        public virtual bool AutoDetectChangesEnabled
        {
            get
            {
                return this.Configuration.AutoDetectChangesEnabled;
            }
            set
            {
                this.Configuration.AutoDetectChangesEnabled = value;
            }
        }

        #endregion
    }
}

    4.  添加EfStartUpTask类用于启动时初数据库进行初始化

using System.Data.Entity;
using Nop.Core.Infrastructure;

namespace DaBoLang.Nop.Plugin.Payments.AliPay.Data
{
    /// <summary>
    /// 命名空间：DaBoLang.Nop.Plugin.Payments.AliPay.Data
    /// 名    称：EfStartUpTask
    /// 功    能：启动任务
    /// 详    细：启动时数据库初始化从不创建数据库
    /// 版    本：1.0.0.0
    /// 作    者：大波浪
    /// 联系方式：http://www.cnblogs.com/yaoshangjin
    /// 说    明：
    /// </summary>
    public class EfStartUpTask : IStartupTask
    {
        public void Execute()
        {
            //It's required to set initializer to null (for SQL Server Compact).
            //otherwise, you'll get something like "The model backing the 'your context name' context has changed since the database was created. Consider using Code First Migrations to update the database"
            Database.SetInitializer<AliPayObjectContext>(null);
        }

        public int Order
        {
            //ensure that this task is run first 
            get { return 0; }
        }
    }
}

到这里数据库相关类已经创建完毕，但是还不能使用，我们需要将这些类注册到依赖注入框架中。

    5.  添加DependencyRegistrar类用于依赖关系注册

using Autofac;
using Autofac.Core;
using DaBoLang.Nop.Plugin.Payments.AliPay.Data;
using DaBoLang.Nop.Plugin.Payments.AliPay.Domain;
using DaBoLang.Nop.Plugin.Payments.AliPay.Services;
using Nop.Core.Configuration;
using Nop.Core.Data;
using Nop.Core.Infrastructure;
using Nop.Core.Infrastructure.DependencyManagement;
using Nop.Data;
using Nop.Web.Framework.Mvc;

namespace DaBoLang.Nop.Plugin.Payments.AliPay
{
    /// <summary>
    /// 命名空间：DaBoLang.Nop.Plugin.Payments.AliPay
    /// 名    称：DependencyRegistrar
    /// 功    能：框架
    /// 详    细：注册
    /// 版    本：1.0.0.0
    /// 作    者：大波浪
    /// 联系方式：http://www.cnblogs.com/yaoshangjin
    /// 说    明：
    /// </summary>
    public class DependencyRegistrar : IDependencyRegistrar
    {
        /// <summary>
        /// Register services and interfaces
        /// </summary>
        /// <param name="builder">Container builder</param>
        /// <param name="typeFinder">Type finder</param>
        /// <param name="config">Config</param>
        public virtual void Register(ContainerBuilder builder, ITypeFinder typeFinder, NopConfig config)
        {
            //数据库上下文
            this.RegisterPluginDataContext<AliPayObjectContext>(builder, "nop_object_context_alipay");

            //为Repository注册数据库上下文
            builder.RegisterType<EfRepository<PaymentInfo>>()
                .As<IRepository<PaymentInfo>>()
                .WithParameter(ResolvedParameter.ForNamed<IDbContext>("nop_object_context_alipay"))
                .InstancePerLifetimeScope();

            builder.RegisterType<EfRepository<RefundInfo>>()
               .As<IRepository<RefundInfo>>()
               .WithParameter(ResolvedParameter.ForNamed<IDbContext>("nop_object_context_alipay"))
               .InstancePerLifetimeScope();


            //注册支付记录服务
            builder.RegisterType<PaymentInfoService>().As<IPaymentInfoService>().InstancePerLifetimeScope();
            //注册退款记录服务
            builder.RegisterType<RefundInfoService>().As<IRefundInfoService>().InstancePerLifetimeScope();
        }

        /// <summary>
        /// Order of this dependency registrar implementation
        /// </summary>
        public int Order
        {
            get { return 1; }
        }
    }
}

好了样数据库相关类就完成了。

六.插件安装、卸载

     现在我们就可以编写支付插件类了，首先创建AliPayPaymentProcessor类，该类继承BasePlugin抽象类，同时继承IPaymentMethod接口。

      nop支付插件需要继承Nop.Services.Payments.IpaymentMethod接口，该接口提供了用于支付相关的方法。接口说明请看下边代码注释（理解不正确的地方请留言指正）

namespace Nop.Services.Payments
{
    /// <summary>
    /// 提供了一个接口用于创建支付网关和方法
    /// </summary>
    public partial interface IPaymentMethod : IPlugin
    {
        #region Methods

        /// <summary>
        /// 付款处理
        /// </summary>
        /// <param name="processPaymentRequest">Payment info required for an order processing</param>
        /// <returns>Process payment result</returns>
        ProcessPaymentResult ProcessPayment(ProcessPaymentRequest processPaymentRequest);

        /// <summary>
        /// 请求付款流程(需要重定向到一个第三方的支付网关使用的URL)
        /// </summary>
        /// <param name="postProcessPaymentRequest">Payment info required for an order processing</param>
        void PostProcessPayment(PostProcessPaymentRequest postProcessPaymentRequest);

        /// <summary>
        /// 是否应该隐藏支付方式,例如购物车内商品不需要配送
        /// <param name="cart">Shoping cart</param>
        /// <returns>true - hide; false - display.</returns>
        bool HidePaymentMethod(IList<ShoppingCartItem> cart);

        /// <summary>
        /// 额外费用
        /// </summary>
        /// <param name="cart">Shoping cart</param>
        /// <returns>Additional handling fee</returns>
        decimal GetAdditionalHandlingFee(IList<ShoppingCartItem> cart);

        /// <summary>
        /// 跟踪付款
        /// </summary>
        /// <param name="capturePaymentRequest">Capture payment request</param>
        /// <returns>Capture payment result</returns>
        CapturePaymentResult Capture(CapturePaymentRequest capturePaymentRequest);

        /// <summary>
        /// 退款
        /// </summary>
        /// <param name="refundPaymentRequest">Request</param>
        /// <returns>Result</returns>
        RefundPaymentResult Refund(RefundPaymentRequest refundPaymentRequest);

        /// <summary>
        /// Voids a payment
        /// </summary>
        /// <param name="voidPaymentRequest">Request</param>
        /// <returns>Result</returns>
        VoidPaymentResult Void(VoidPaymentRequest voidPaymentRequest);

        /// <summary>
        /// 定期支付
        /// </summary>
        /// <param name="processPaymentRequest">Payment info required for an order processing</param>
        /// <returns>Process payment result</returns>
        ProcessPaymentResult ProcessRecurringPayment(ProcessPaymentRequest processPaymentRequest);

        /// <summary>
        /// 取消定期支付
        /// </summary>
        /// <param name="cancelPaymentRequest">Request</param>
        /// <returns>Result</returns>
        CancelRecurringPaymentResult CancelRecurringPayment(CancelRecurringPaymentRequest cancelPaymentRequest);

        /// <summary>
        /// 订单创建后但支付未成功，是否支持重复支付
        /// </summary>
        /// <param name="order">Order</param>
        /// <returns>Result</returns>
        bool CanRePostProcessPayment(Order order);

        /// <summary>
        /// 配置路由
        /// </summary>
        /// <param name="actionName">Action name</param>
        /// <param name="controllerName">Controller name</param>
        /// <param name="routeValues">Route values</param>
        void GetConfigurationRoute(out string actionName, out string controllerName, out RouteValueDictionary routeValues);

        /// <summary>
        /// 支付信息路由
        /// </summary>
        /// <param name="actionName">Action name</param>
        /// <param name="controllerName">Controller name</param>
        /// <param name="routeValues">Route values</param>
        void GetPaymentInfoRoute(out string actionName, out string controllerName, out RouteValueDictionary routeValues);

        Type GetControllerType();

        #endregion

        #region Properties

        /// <summary>
        /// 支持跟踪
        /// </summary>
        bool SupportCapture { get; }

        /// <summary>
        /// 支持部分退款
        /// </summary>
        bool SupportPartiallyRefund { get; }

        /// <summary>
        /// 支持退款
        /// </summary>
        bool SupportRefund { get; }

        /// <summary>
        /// 无效
        /// </summary>
        bool SupportVoid { get; }

        /// <summary>
        /// 定期付款方式
        /// </summary>
        RecurringPaymentType RecurringPaymentType { get; }

        /// <summary>
        /// 支付方式
        /// </summary>
        PaymentMethodType PaymentMethodType { get; }

        /// <summary>
        /// 是否显示插件的付款信息页面
        /// </summary>
        bool SkipPaymentInfo { get; }

        /// <summary>
        /// 在支付方式页面将显示的支付方式描述
        /// </summary>
        string PaymentMethodDescription { get; }

        #endregion
    }
}

重写安装、卸载处理方法，AliPayPaymentSettings类用于用于保存插件配置

#region 插件安装/卸载

        public override void Install()
        {
            //配置
            var settings = new AliPayPaymentSettings
            {
                SellerEmail = "",
                Key = "",
                Partner = "",
                AdditionalFee = 0,
            };

            _settingService.SaveSetting(settings);

            //安装数据表
            _objectContext.Install();

            //本地化资源
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.RedirectionTip", "您将被重定向到支付宝网站完成订单.");
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.SellerEmail", "卖方邮箱");
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.SellerEmail.Hint", "支付宝卖方电子邮箱.");
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.Key", "Key");
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.Key.Hint", "输入 key.");
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.Partner", "Partner");
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.Partner.Hint", "输入 partner.");
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.AdditionalFee", "额外费用");
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.AdditionalFee.Hint", "客户选择此支付方式将付额外的费用.");
            this.AddOrUpdatePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.PaymentMethodDescription", "使用支付宝进行支付");

            base.Install();
        }

        public override void Uninstall()
        {
            //配置
            _settingService.DeleteSetting<AliPayPaymentSettings>();

            //本地化资源
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.SellerEmail.RedirectionTip");
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.SellerEmail");
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.SellerEmail.Hint");
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.Key");
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.Key.Hint");
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.Partner");
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.Partner.Hint");
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.AdditionalFee");
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.AdditionalFee.Hint");
            this.DeletePluginLocaleResource("DaBoLang.Plugins.Payments.AliPay.PaymentMethodDescription");

            //卸载数据表
            _objectContext.Uninstall();

            base.Uninstall();
        }

        #endregion

using Nop.Core.Configuration;

namespace DaBoLang.Nop.Plugin.Payments.AliPay
{
    /// <summary>
    /// 命名空间：DaBoLang.Nop.Plugin.Payments.AliPay
    /// 名    称：AliPayPaymentSettings
    /// 功    能：配置类
    /// 详    细：支付宝配置
    /// 版    本：1.0.0.0
    /// 文件名称：AliPayPaymentSettings.cs
    /// 作    者：大波浪
    /// 联系方式：http://www.cnblogs.com/yaoshangjin
    /// 说    明：
    /// </summary>
    public class AliPayPaymentSettings : ISettings
    {
        /// <summary>
        /// 卖家Email
        /// </summary>
        public string SellerEmail { get; set; }
        /// <summary>
        /// Key
        /// </summary>
        public string Key { get; set; }
        /// <summary>
        /// PID
        /// </summary>
        public string Partner { get; set; }
        /// <summary>
        /// 额外费用
        /// </summary>
        public decimal AdditionalFee { get; set; }
    }
}

最后看下安装、卸载处理流程

七.插件配置

     接下来我们开发插件配置并支持多店铺设置，插件类中GetConfigurationRoute方法用于返回路由信息，我们定义一个路由到

AliPayController控制器的Configure方法下的路由，Configure用于处理配置。

     Models文件夹中ConfigurationModel.cs类为模型类，用于沟通控制器与视图之间的数据。这里不再具体讨论。

八.支付功能

    

     付款的时候我们需要跳转到支付宝页面进行操作，因此AliPayPaymentProcessor类中

     PaymentMethodType返回PaymentMethodType.Redirection告诉nop我们需要到第三方进行支付。    

 public PaymentMethodType PaymentMethodType
        {
            get
            {
                return PaymentMethodType.Redirection;
            }
        }

     然后实现PostProcessPayment方法，用于处理支付宝付款。Alipay文件夹里是支付宝辅助类。

 public void PostProcessPayment(PostProcessPaymentRequest postProcessPaymentRequest)
        {
            var partner = _aliPayPaymentSettings.Partner;

            if (string.IsNullOrEmpty(partner))
                throw new Exception("合作身份者ID 不能为空");

            var key = _aliPayPaymentSettings.Key;

            if (string.IsNullOrEmpty(key))
                throw new Exception("MD5密钥不能为空");

            var sellerEmail = _aliPayPaymentSettings.SellerEmail;

            if (string.IsNullOrEmpty(sellerEmail))
                throw new Exception("卖家Email 不能为空");

            var customer = _workContext.CurrentCustomer;//当前用户
            string username = customer.Username;


            //商户订单号，商户网站订单系统中唯一订单号，必填
            string out_trade_no = postProcessPaymentRequest.Order.Id.ToString().Trim();//订单编号

            //订单名称，必填
            string subject = _storeContext.CurrentStore.Name + ":订单" + out_trade_no;

            //付款金额，必填
            string total_fee = postProcessPaymentRequest.Order.OrderTotal.ToString("0.00", CultureInfo.InvariantCulture);

            //商品描述，可空
            string body = _storeContext.CurrentStore.Name + ":用户_" + username;

            //支付配置信息
            var aliPayDirectConfig = new AlipayDirectConfig()
            {
                key = _aliPayPaymentSettings.Key,
                partner = _aliPayPaymentSettings.Partner,
                seller_email = _aliPayPaymentSettings.SellerEmail,
                notify_url = _webHelper.GetStoreLocation(false) + "Plugins/AliPay/Notify",
                return_url = _webHelper.GetStoreLocation(false) + "Plugins/AliPay/Return",
                sign_type = "MD5",
                input_charset= "utf-8",
            };
            //把请求参数打包成数组
            SortedDictionary<string, string> sParaTemp = new SortedDictionary<string, string>();
            sParaTemp.Add("service", aliPayDirectConfig.service);
            sParaTemp.Add("partner", aliPayDirectConfig.partner);
            sParaTemp.Add("seller_email", aliPayDirectConfig.seller_email);
            sParaTemp.Add("payment_type", aliPayDirectConfig.payment_type);
            sParaTemp.Add("notify_url", aliPayDirectConfig.notify_url);
            sParaTemp.Add("return_url", aliPayDirectConfig.return_url);
            sParaTemp.Add("_input_charset", aliPayDirectConfig.input_charset);
            sParaTemp.Add("out_trade_no", out_trade_no);
            sParaTemp.Add("subject", subject);
            sParaTemp.Add("body", body);
            sParaTemp.Add("total_fee", total_fee);
            //创建支付宝请求
            var post = AlipaySubmit.BuildRequest(sParaTemp, aliPayDirectConfig, "POST");
            post.Post();

        }

     调用支付宝接口时需要设置notify_url地址用于接收付款通知，return_url地址用支付成功后支付宝跳转到该地址。

notify_url = _webHelper.GetStoreLocation(false) + "Plugins/AliPay/Notify",
return_url = _webHelper.GetStoreLocation(false) + "Plugins/AliPay/Return",

     RouteProvider.cs类用于注册路由,在这里定义上边两个地址的路由。

using System.Web.Mvc;
using System.Web.Routing;
using Nop.Web.Framework.Mvc.Routes;

namespace DaBoLang.Nop.Plugin.Payments.AliPay
{
    /// <summary>
    /// 命名空间：DaBoLang.Nop.Plugin.Payments.AliPay
    /// 名    称：RouteProvider
    /// 功    能：路由
    /// 详    细：定义路由
    /// 版    本：1.0.0.0
    /// 文件名称：RouteProvider.cs
    /// 作    者：大波浪
    /// 联系方式：http://www.cnblogs.com/yaoshangjin
    /// 说    明：
    /// </summary>
    public partial class RouteProvider : IRouteProvider
    {
        #region Methods

        public void RegisterRoutes(RouteCollection routes)
        {
            //支付通知路由
            routes.MapRoute("DaBoLang.Plugin.Payments.AliPay.Notify",
                 "Plugins/AliPay/Notify",
                 new { controller = "AliPay", action = "Notify" },
                 new[] { "DaBoLang.Nop.Plugin.Payments.AliPay.Controllers" }
            );

            //支付页面跳转同步通知页面
            routes.MapRoute("DaBoLang.Plugin.Payments.AliPay.Return",
                 "Plugins/AliPay/Return",
                 new { controller = "AliPay", action = "Return" },
                 new[] { "DaBoLang.Nop.Plugin.Payments.AliPay.Controllers" }
            );

            //退款通知路由
            routes.MapRoute("Plugin.Payments.AliPay.RefundNotify",
              "Plugins/AliPay/RefundNotify",
              new { controller = "AliPay", action = "RefundNotify" },
              new[] { "DaBoLang.Nop.Plugin.Payments.AliPay.Controllers" }
            );
        }

        #endregion

        #region Properties

        public int Priority
        {
            get
            {
                return 0;
            }
        }

        #endregion
    }
}

     Plugins/AliPay/Notify 会调用AliPayController控制器类Notify方法进行处理

     Plugins/AliPay/Return 会调用AliPayController控制器类Return方法进行处理

AliPayController->Notify方法用于接收支付宝通知，当支付成功后会调用该方法，该方法中会处理订单支付状态，并在付款信息表中添加付款记录。

AliPayController->Return方法定义返回位置。

九.退款功能

     支持全额退款，需要插件类SupportRefund属性返回true，支持部分退款需要SupportPartiallyRefund属性返回true。

     退款需要实现Refund方法，当退款操作时nop会调用Refund方法，本插件中会新建退款信息保存在退款表中，然后重定向到支付宝进行有密退款。

      支付宝接口也需要notify_url地址，用于退款成功后接受通知，我们在前边RouteProvider路由表中定义了退款通知路由，AliPayController控制器RefundNotify方法来处理。

      RefundNotify方法会改变订单付款状态，修改订单退款金额，退款记录表中修改已退款状态等等业务逻辑。具体实现请看源代码。

十.服务类

     Services文件夹用于保存服务类。

     IPaymentInfoService接口：用于对付款记录处理，如对付款表的增删改查等。

     IRefundInfoService接口：用于对退款记录的处理，如对退款表的增删改查等操作。

nop使用IRepository<T>来进行数据处理的封装（Dao层），T为实体类

#region 属性
private readonly IRepository<RefundInfo> _refundInfoRepository;
#endregion
#region 构造
public RefundInfoService(IRepository<RefundInfo> refundInfoRepository)
{
     this._refundInfoRepository = refundInfoRepository;
}
#endregion

接下来创建接口实现类，PaymentInfoService和RefundInfoService用于实现业务逻辑。

最后我们需要把接口和实现类注册到依赖注入容器中，在DependencyRegistrar文件中进行注册。

//注册支付记录服务
 builder.RegisterType<PaymentInfoService>().As<IPaymentInfoService>().InstancePerLifetimeScope();
//注册退款记录服务
builder.RegisterType<RefundInfoService>().As<IRefundInfoService>().InstancePerLifetimeScope();

十一.总结

• 本文通过完整的实例介绍了支付插件接口的扩展。
• 实现IPaymentMethod接口用于支付插件接口扩展。
• 通过AliPayObjectContext数据库上下文扩展来对数据库表操作。
• 理解支付宝即时到账支付与退款流程。
• 路由注册、依赖注入注册。

注意：调试时项目一定要部署在公网中，这样支付宝才能正确的调用通知地址，否则插件就会失效。

文中有不正确的观点请指正，如果您觉得本文对您有帮助，请转载支持

本文地址：http://www.cnblogs.com/yaoshangjin/p/7290003.html

本文为大波浪原创、转载请注明出处。