提取 C# 中的方法以在整个项目中使用

本文关键字:项目 方法 提取 | 更新日期: 2023-09-27 18:35:36

请原谅这里的冗长代码,我也意识到对于任何面向对象的开发人员来说,这可能是一个非常基本的基本问题,但我是 .NET 深端的前端开发人员,并尝试通过实际示例了解类和方法。 我已经阅读了解释这些东西的资源,但立即陷入了现实世界代码的复杂性。

基本上,我有很多方法可以向网页添加评论并操纵状态(标记为垃圾邮件,删除等)。 其中许多方法调用"电子邮件通知"方法,该方法在每个阶段向管理员发送电子邮件。 效果很好。

但是,我想在项目的其他地方使用"电子邮件通知"方法,从不同的.cs文件中调用它。 当我尝试这样做时,它无法识别该方法,因为(我认为!?)它不是一个公共静态方法。

谁能向我解释如何提取电子邮件通知方法,以便我可以在代码周围的不同位置使用它? 我尝试在其中使用此方法创建一个新类,但我无法让它工作。

using System;
using System.Net.Mail;
namespace UComment.Domain
{
public class Comment
{
    public delegate void CommentCreatedEventHandler(Comment sender, EventArgs e);
    public delegate void CommentDeletedEventHandler(Comment sender, EventArgs e);
    public delegate void CommentSpamEventHandler(Comment sender, EventArgs e);
    public delegate void CommentApprovedEventHandler(Comment sender, EventArgs e);
    public static event CommentCreatedEventHandler CommentCreated;
    public static event CommentDeletedEventHandler CommentDeleted;
    public static event CommentSpamEventHandler CommentSpam;
    public static event CommentApprovedEventHandler CommentApproved;
    protected virtual void OnCommentCreated(EventArgs e)
    {
        if (CommentCreated != null) CommentCreated(this, e);
    }
    protected virtual void OnCommentSpam(EventArgs e)
    {
        if (CommentSpam != null) CommentSpam(this, e);
    }
    protected virtual void OnCommentApproved(EventArgs e)
    {
        if (CommentApproved != null) CommentApproved(this, e);
    }
    protected virtual void OnCommentDelete(EventArgs e)
    {
        if (CommentDeleted != null) CommentDeleted(this, e);
    }

    public int Id { get; set; }
    public int ParentNodeId { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public string Website { get; set; }
    public bool Spam { get; set; }
    public bool Approved { get; set; }
    public DateTime Created { get; set; }
    public string CommenText { get; set; }
    public int StatusId { get; set; }
    public Comment(int id)
    {
        Id = id;
        var sqlHelper = DataLayerHelper.CreateSqlHelper(cms.GlobalSettings.DbDSN);
        var reader = sqlHelper.ExecuteReader("select * from Comment where id = @id",
                                             sqlHelper.CreateParameter("@id", id));
        if(!reader.HasRecords) throw new Exception(string.Format("Comment with id {0} was not found", id));
        reader.Read();
        Name = reader.GetString("name");
        ParentNodeId = reader.GetInt("nodeid");
        Email = reader.GetString("email");
        Website = reader.GetString("website");
        Approved = reader.GetBoolean("approved");
        Spam = reader.GetBoolean("Spam");
        Created = reader.GetDateTime("created");
        CommenText = reader.GetString("comment");
        StatusId = reader.GetInt("statusid");
    }
    private Comment()
    {
    }
    /// <summary>
    /// Set as approved, mark as Not Spam - ignore HAM status
    /// </summary>
    public void MarkAsApproved()
    {
        var sqlHelper = DataLayerHelper.CreateSqlHelper(cms.GlobalSettings.DbDSN);
        sqlHelper.ExecuteNonQuery(
             "update comment set approved = 1, spam = 0, statusid = 2 where id = @id",
             sqlHelper.CreateParameter("@id", Id));
        OnCommentApproved(EventArgs.Empty);
        // Send approval email
        EmailNotification(1);
    }
    /// <summary>
    /// Remove approval status. Ignore Spam and Ham states
    /// </summary>
    public void MarkAsNotApproved()
    {
        var sqlHelper = DataLayerHelper.CreateSqlHelper(cms.GlobalSettings.DbDSN);
        sqlHelper.ExecuteNonQuery(
             "update comment set approved = 0, statusid = 3 where id = @id",
             sqlHelper.CreateParameter("@id", Id));
        OnCommentApproved(EventArgs.Empty);
        // Send rejection email
        EmailNotification(2);
    }

    /// <summary>
    /// Spam cannot be ham or approved
    /// </summary>
    public void MarkAsSpam()
    {
        var sqlHelper = DataLayerHelper.CreateSqlHelper(cms.GlobalSettings.DbDSN);
        sqlHelper.ExecuteNonQuery(
             "update comment set spam = 1, ham = 0, approved = 0, statusid = 3 where id = @id",
             sqlHelper.CreateParameter("@id", Id));
        OnCommentSpam(EventArgs.Empty);
        // No email notification required - spammer not worthy of a reason for rejection
    }

    /// <summary>
    /// Ham is "not spam" - approved comments from Akismet. 
    /// </summary>
    public void MarkAsHam()
    {
        var sqlHelper = DataLayerHelper.CreateSqlHelper(cms.GlobalSettings.DbDSN);
        sqlHelper.ExecuteNonQuery(
           "update comment set spam = 0, ham = 1 where id = @id",
           sqlHelper.CreateParameter("@id", Id));
        // No email notification required, simply marking spam as ham
    }
    public void Delete()
    {
        if (Id < 1) return;
        var sqlHelper = DataLayerHelper.CreateSqlHelper(cms.GlobalSettings.DbDSN);
        sqlHelper.ExecuteNonQuery("delete from comment where id = @id", sqlHelper.CreateParameter("@id", Id));
        Id = -1;
        OnCommentDelete(EventArgs.Empty);
        // Permanent deletion
    }
    public void Reject()
    {
        if (Id < 1) return;
        var sqlHelper = DataLayerHelper.CreateSqlHelper(cms.GlobalSettings.DbDSN);
        sqlHelper.ExecuteNonQuery("update comment set statusid = 3 where id = @id", sqlHelper.CreateParameter("@id", Id));
        //Id = -1;
        //OnCommentDelete(EventArgs.Empty);
        // Send rejection email
        EmailNotification(2);
    }


    public static Comment MakeNew(int parentNodeId, string name, string email, string website, bool approved, bool spam, DateTime created, string commentText, int statusId)
    {
        var c = new Comment
            {
                ParentNodeId = parentNodeId,
                Name = name,
                Email = email,
                Website = website,
                Approved = approved,
                Spam = spam,
                Created = created,
                CommenText = commentText,
                StatusId = statusId
            };
        var sqlHelper = DataLayerHelper.CreateSqlHelper(cms.GlobalSettings.DbDSN);
        c.Id = sqlHelper.ExecuteScalar<int>(
            @"insert into Comment(mainid,nodeid,name,email,website,comment,approved,spam,created,statusid) 
                values(@mainid,@nodeid,@name,@email,@website,@comment,@approved,@spam,@created,@statusid)",
            sqlHelper.CreateParameter("@mainid", -1),
            sqlHelper.CreateParameter("@nodeid", c.ParentNodeId),
            sqlHelper.CreateParameter("@name", c.Name),
            sqlHelper.CreateParameter("@email", c.Email),
            sqlHelper.CreateParameter("@website", c.Website),
            sqlHelper.CreateParameter("@comment", c.CommenText),
            sqlHelper.CreateParameter("@approved", c.Approved),
            sqlHelper.CreateParameter("@spam", c.Spam),
            sqlHelper.CreateParameter("@created", c.Created),
            sqlHelper.CreateParameter("@statusid", c.StatusId));
        c.OnCommentCreated(EventArgs.Empty);
        if (c.Spam)
        {
            c.OnCommentSpam(EventArgs.Empty);
        }
        if (c.Approved)
        {
            c.OnCommentApproved(EventArgs.Empty);
        }
        return c;
    }
    public override string ToString()
    {
        return @"ParentNodeId " + ParentNodeId + @"
        Name " + Name + @"
        Email " + Email + @"
        Website " + Website + @"
        Approved " + Approved + @"
        Spam " + Spam + @"
        Created "+ Created + @"
        CommenText " + CommenText + Environment.NewLine;
    }

    /// <summary>
    /// Send email notification
    /// </summary>
    public void EmailNotification(int notificationType)
    {
        var uCommentAdminEmail = Config.GetUCommentSetting("uCommentAdminEmail");
        MailAddress to = null;
        MailAddress from = new MailAddress(uCommentAdminEmail);
        string subject = null;
        string body = null;
        switch (notificationType)
        {
            case 1:
                // Comment approved
                to = new MailAddress("me@mydomain.com");
                subject = "Comment approved";
                body = @"The comment you posted has been approved";
                break;
            case 2:
                // Comment rejected
                to = new MailAddress("me@mydomain.com");
                subject = "Comment rejected";
                body = @"The comment you posted has been rejected";
                break;
        }
        MailMessage message = new MailMessage(from, to);
        message.Subject = subject;
        message.Body = body;
        SmtpClient client = new SmtpClient();           
        try
        {
            client.Send(message);
        }
        catch (Exception ex)
        {
            Console.WriteLine("Exception caught in EmailNotification: {0}", ex.ToString());
        }
        finally
        {
            //
        }

    }

}
}

感谢您的任何指点!

提取 C# 中的方法以在整个项目中使用

您可以:

  1. 将其提取到静态类上的静态方法
  2. 创建具有实例方法的单一实例类
  3. 为 MessageSender 创建一个类和接口,并使用 DI 将其注入到需要的位置。

这取决于项目的规模:对于小项目1.可能就足够了,对于大型和复杂(如果你有DI),需要3个。

您在这里拥有的是一个公共方法,但由于它未声明为静态(public static void EmailNotification...),因此如果不创建它所在的类的实例,就无法使用它。

using System;
namespace UComment.Domain
{
    public class MyOtherClass
    {
         public void MyMethod()
         {
             Comment c = new Comment();
             c.EmailNotification(1);
         }
    }
}

你可以声明方法 static ,这样你就可以这样调用它:

using System;
namespace UComment.Domain
{
    public class MyOtherClass
    {
         public void MyMethod()
         {
             Comment.EmailNotification(1);
         }
    }
}

如果尝试从其他命名空间使用它,则需要通过 using 语句或内联指定完整命名空间来包含命名空间。

using System;
using UComment.Domain;
namespace UComment.OtherNamespace
{
    public class MyOtherClass
    {
         public void MyMethod()
         {
             Comment c = new Comment();
             c.EmailNotification(1);
         }
    }
}

using System;
namespace UComment.OtherNamespace
{
    public class MyOtherClass
    {
         public void MyMethod()
         {
             UComment.Domain.Comment c = new UComment.Domain.Comment();
             c.EmailNotification(1);
         }
    }
}

您认为,如果您希望将其作为常用方法,它应该独立于 Comment 类,这是正确的。我刚才描述的相同限制也适用于执行此操作。此外,您必须确保任何适当的 using 语句都在新类上,并且还考虑了 EmailNotification 中的依赖项。

你的类做的东西太多了!

将其拆分为不同的类型,每个类型只需根据关注点分离解决一种类型的问题。

与电子邮件发送相同,创建一个 EmailSender 类(或其他名称)并将 Send 方法集中在那里。

您还可以创建一个接口(例如 ISmtpClientFactory ) 传递给 EmailSender 类来抽象具体系统以发送电子邮件并改善测试体验。

只有在生产环境中你才真正发送电子邮件,在测试环境中你可以使用假工厂来模拟发送。

public class EmailSender
{
    private readonly ISmtpClientFactory factory;
    public EmailSender(ISmtpClientFactory factory)
    {
        this.factory = factory;
    }
    public void Send(MailMessage message)
    {
        using (var client = factory.Create())
        {
            using (message)
            {
                client.Send(message);
            }
        }
    }
}
new EmailSender(new SmtpClientFactory()).Send(AdviceMessageFactory.Create(...));

你可以把它放在它自己的类中(就像你已经尝试过的那样)并使该方法成为静态的。

如果这个新类是电子邮件助手,你将像这样调用该方法:

EmailHelper.EmailNotification(1);

根据新类的命名空间,您可能还需要在使用它的每个文件的顶部都有一个 using 语句。

看起来不像 如果您创建一个(公共)类并在其中包含该方法,它应该会导致任何问题。该方法应接受发送电子邮件所需的所有属性。可以创建该类的实例并调用该方法。