自动映射器从 XML 创建对象

Question

如果我有以下类：

class SPUser
{
    public int ID { get; set; }

    public string Name { get; set; }
    public string LoginName { get; set; }
    public string Email { get; set; }

    public bool IsSiteAdmin { get; set; }
    public bool IsSiteAuditor { get; set; }
    public bool IsDomainGroup { get; set; }

    public List<SPGroup> Groups { get; set; }
}

并且我正在使用 sharepoint Web 服务，它返回一个 XML，其中包含类中每个属性的属性，例如：

<Users>
    <User Name="name" Description="desc" ..... />
</Users>

有没有办法使用 AutoMapper 将 XML 片段映射到 SPUser 类实例？

Answer 1

博客已被删除 - 这是 @DannyDouglass 的帖子的 Bing 存档

通过 AutoMapper 和 Linq-to-Xml 简化使用 Xml 数据

我最近在工作中遇到了一个需要手动使用多个 SOAP Web 服务的场景，我相信您可以想象当时相当单调。我和一位同事（Seth Carney）尝试了几种不同的方法，但我们最终确定了一种解决方案，可以简化 xml 的使用，并最终使代码更易于测试。该解决方案的核心是利用 AutoMapper（一种开源对象到对象映射工具）在 XElement 之间创建链接（http://msdn.microsoft.com/en-us/library/system.xml.linq.xelement.aspx）在我们创建的 SOAP 消息和自定义契约中返回 - 以可重用的形式方式。

我整理了一个快速演示，展示了如何使用相同的方法来使用和显示 Twitter 公共时间线 (http: //api.twitter.com/1/statuses/public_timeline.xml）（使用 API 的 Xml 响应类型）。

注意：以下示例的源代码可以在我的 GitHub 页面上找到：https://github.com/DannyDouglass/AutoMapperXmlMappingDemo

1. 获取项目设置

创建基本的 MVC3（下载测试版）项目和关联的测试项目后，第一步是安装 AutoMapper 包。我一直在使用 NuGet（微软最近发布的包管理系统）来安装任何开源依赖项。以下命令是在我的 MVC3 项目中设置 AutoMapper 所需的全部内容（在此处阅读有关 NuGet 的更多信息(http://weblogs.asp.net/scottgu/archive/2010/10/06/announcing-nupack-asp-net-mvc-3-beta-and-webmatrix-beta-2.aspx)和这里（ http://weblogs.asp.net/scottgu/archive/2010/10/06/announcing-nupack-asp-net-mvc-3-beta-and-webmatrix-beta-2.aspx）） :

PM> add-package AutoMapper

2. 创建映射

安装了 AutoMapper 后，我已准备好开始创建 xml 到对象映射所需的组件。第一步是创建一个在我的应用程序中使用的快速合约来表示 Tweet 对象：

public interface ITweetContract
{
ulong Id { get; set; }
string Name { get; set; }
string UserName { get; set; }
string Body { get; set; }
string ProfileImageUrl { get; set; }
string Created { get; set; }
}

这里没有什么疯狂的 – 只是一个简单的实体。这些都是 Twitter API 的响应中提供的字段，某些字段使用不同的名称。在源对象和目标对象具有相同名称的简单情况下，您可以使用以下语法非常快速地设置映射：

Mapper.CreateMap<SourceObj, DestinationObj>();

但是，AutoMapper 默认情况下不支持 Xml，我必须指定要映射的字段。使用 AutoMapper 中的 Fluent API，我可以链接我的字段映射。看一下我的示例中映射的一个示例字段 - 推文的正文：

Mapper.CreateMap<XElement, ITweetContract>()
.ForMember(
    dest => dest.Body,
    options => options.ResolveUsing<XElementResolver<string>>()
        .FromMember(source => source.Element("text")))

一开始可能看起来很复杂，但这里真正发生的一切是我们向 AutoMapper 提供有关在源对象中使用什么值以及如何使用的详细信息。将其映射到目标对象的属性。在上面的 Body 字段映射中，我想重点关注一行：

options => options.ResolveUsing<XElementResolver<ulong>>()
                    .FromMember(source => source.Element("id")))  

XElementResolver 是一个自定义值解析器 (http://automapper.codeplex.com/wikipage?title=Custom%20Value%20Resolvers)，Seth 提出来处理解析 XmlElement 源对象以检索用于映射的强类型值。我稍后将详细介绍这一点，但在继续之前，请先看一下我的完整映射：

Mapper.CreateMap<XElement, ITweetContract>()
.ForMember(
    dest => dest.Id,
    options => options.ResolveUsing<XElementResolver<ulong>>()
        .FromMember(source => source.Element("id")))
.ForMember(
    dest => dest.Name,
    options => options.ResolveUsing<XElementResolver<string>>()
        .FromMember(source => source.Element("user")
            .Descendants("name").Single()))
.ForMember(
    dest => dest.UserName,
    options => options.ResolveUsing<XElementResolver<string>>()
        .FromMember(source => source.Element("user")
            .Descendants("screen_name").Single()))
.ForMember(
    dest => dest.Body,
    options => options.ResolveUsing<XElementResolver<string>>()
        .FromMember(source => source.Element("text")))
.ForMember(
    dest => dest.ProfileImageUrl,
    options => options.ResolveUsing<XElementResolver<string>>()
        .FromMember(source => source.Element("user")
            .Descendants("profile_image_url").Single()))
.ForMember(
    dest => dest.Created,
    options => options.ResolveUsing<XElementResolver<string>>()
        .FromMember(source => source.Element("created_at")));

3. Generic XElementResolver

这个自定义值解析器是允许这些 XElement-to-Contract 映射在原始解决方案中工作的真正关键。正如我们在上面看到的，我在这个示例中重复使用了这个解析器。这就是创建自定义解析器类所需的全部内容：

public class XElementResolver<T> : ValueResolver<XElement, T>
{
protected override T ResolveCore(XElement source)
{
    if (source == null || string.IsNullOrEmpty(source.Value))
        return default(T);  
    return (T)Convert.ChangeType(source.Value, typeof(T));
}
}

这个通用 XElementResolver 允许您轻松传递在上面的映射中检索到的值的类型。例如，以下语法用于强类型化从上述 Id 字段的 .ForMember() 声明中的 XmlElement 检索到的值：

ResolveUsing<XElementResolver<ulong>>()

在完全配置和实例化我的映射后，我准备调用 Twitter API 并利用 AutoMapper 来显示最新的公共时间表。

4. 将各个部分放在一起

我创建了一个简单的类，负责检索 Twitter API 响应：

public class TwitterTimelineRetriever
{
private readonly XDocument _twitterTimelineXml;  
public TwitterTimelineRetriever()
{
    _twitterTimelineXml = XDocument
        .Load("http://api.twitter.com/1/statuses/public_timeline.xml");
}  
public IEnumerable<ITweetContract> GetPublicTimeline(int numberOfTweets)
{
    var tweets = _twitterTimelineXml.Descendants("status")
        .Take(numberOfTweets);  
    return tweets.Select(Mapper.Map<XElement, ITweetContract>).ToList();
}
}

GetPublicTimeline 方法是一个简单的方法，您猜对了，它通过利用我们之前创建的地图返回 Twitter 公共时间线：

return tweets.Select(Mapper.Map<XElement, ITweetContract>).ToList();

在我的 MVC3 站点的 HomeController 中，我可以快速调用检索方法，请求最后 10 个结果：

public class HomeController : Controller
{
private TwitterTimelineRetriever _twitterTimelineRetriever;  
public ActionResult Index()
{
    _twitterTimelineRetriever = new TwitterTimelineRetriever();  
    ViewModel.Message = "Twitter Public Timeline";  
    return View(_twitterTimelineRetriever.GetPublicTimeline(10));
}
}

最后，使用 Microsoft 的新 Razor 视图引擎在我的视图中进行一些格式化后，我显示了我的公共时间线！

Answer 2

您需要查看 .NET 中的 XML 序列化 - 这就是将对象序列化为 XML 或从 XML 反序列化的方法。

Automapper 可用于设置两个对象之间的属性 - 它根本不处理 XML。

更多资源：

• C# 教程 - XML 序列化

Answer 3

今天有点晚了，但有人使用 AutoMapper 将 XML 映射到 POCO，而不是沿着 XMLSerialization 路线。我发现以下博客条目：-
通过 AutoMapper 简化 Xml 数据的使用和 Linq-to-Xml

如果示例还不够，这足以让您开始实现自己的通用自定义解析器。

编辑：固定链接
编辑：真正固定的链接

Answer 4

您可以使用 XML 反序列化来实现此目的。在 .NET 中，我们有 XmlSerializer 和 DataContractSerializer