如何在WebAPI控制器中使用dto

本文关键字：dto 控制器 WebAPI | 更新日期: 2023-09-27 18:17:30

我有点困惑如何在我的WebAPI控制器中使用dto。我使用实体框架的数据库第一概念。生成了以下实体数据模型:

//Generated class by EDM:
public partial class Address
    {
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2214:DoNotCallOverridableMethodsInConstructors")]
        public Address()
        {
            this.Member = new HashSet<Member>();
        }
        public int Id { get; set; }
        public string Street { get; set; }
        public Nullable<short> Street_Number { get; set; }
        public Nullable<decimal> Zip { get; set; }
        public string City { get; set; }
        public string Country { get; set; }
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
        public virtual ICollection<Member> Member { get; set; }
    }

要使用数据注释，我需要定义一个AddressDTO，因为每次当我需要修改EDM时，数据模型将再次生成，并且数据注释将丢失。

接下来，我定义了AddressDTO:

public class AddressDTO
    {
        public int Id { get; set; }
        [Required]
        [StringLength(100,ErrorMessage="The max. length of the street name is 100 characters.")]
        public string Street { get; set; }
        public Nullable<short> Street_Number { get; set; }
        [Required]
        public Nullable<decimal> Zip { get; set; }
        [Required]
        [RegularExpression(@"[a-z,A-Z]",ErrorMessage="Only characters are allowed.")]
        public string City { get; set; }
        [Required]
        public string Country { get; set; }
    }

控制器看起来像下面的代码:

    [RoutePrefix("api/address")]
    public class AddressController : ApiController
    {
        private PersonEntities db = new PersonEntities();
        // GET: api/Address
        [HttpGet]
        [ResponseType(typeof(AddressDTO))]
        public async Task<IHttpActionResult> GetAll()
        {
            var addressList = await db.Address.ToListAsync();
            return Ok(addressList);
        }
     }
当我启动RestAPI在浏览器中显示结果时，我总是得到以下json结果: 
[
    {
        "Member": [ ],
        "Id": 1,
        "Street": "Example Street",
        "Street_Number": 1,
        "Zip": 12345.0,
        "City": "New York",
        "Country": "USA" 
    },...
]

但是我需要以下期望的结果:

[
        {
            "Street": "Example Street",
            "Street_Number": 1,
            "Zip": 12345.0,
            "City": "New York",
            "Country": "USA" 
        },...
    ]

有谁知道我该如何解决这个问题吗?

如何在WebAPI控制器中使用dto

您的新编辑仅仅意味着您不需要AddressDTO模型中的Id和Member属性。当您返回List<Address>时，您应该将结果塑造为List<AddressDTO>。

所以只要从AddressDTO中删除未使用的属性，然后通过选择新的AddressDTO和设置属性来塑造结果:

var result = db.Address.Select(x=> new AddressDTO()
                                   { 
                                       Street = x.Id, 
                                       Street_Number = x.Street_Number,
                                       City = x.City,
                                       Country = x.Country
                                   }).ToListAsync();

如果您想使linq更短，您可以将这样的构造函数添加到AddressDTO:

public AddressDTO(Address x)
{
    Street = x.Id;
    Street_Number = x.Street_Number;
    City = x.City;
    Country = x.Country;
}

Then in controller:

var result = db.Address.Select(x=> new AddressDTO(x)).ToListAsync();

同样在大型项目中，您可以依赖于一些对象映射器，如回答中提到的auto mapper

使用Automapper这样的库来处理您的需求。

然后你只需要修改下面一行，例如:

var addressList = await Mapper.Map<IList<AddressDto>>(db.Address.ToListAsync());

这将把你的地址列表转换成一个AddressDto列表，在那里你可以控制转换什么或者不转换什么，比如不传递成员给你的视图。如果字段名相同，Automapper会自动知道要转换什么。

相关文章：