如何在WebAPI控制器中使用DTO？

Question

我有点困惑如何在我的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" 
        },...
    ]

有谁知道如何解决这个问题？

Answer 1

您的新编辑只是意味着您不需要Id和模型中的Member属性AddressDTO.你应该把结果塑造成List<AddressDTO>你回归的一段时间List<Address>.

因此,只需从中删除未使用的属性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;
}

然后在控制器中:

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

同样在一个大型项目中,您可以依赖于一些对象映射器,如答案中提到的自动映射器.

Answer 2

使用Automapper 之类的库来处理您的需求。

然后您只需要将以下行修改为例如：

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

这会将您的地址列表转换为 AddressDto 列表，您可以在其中控制转换或不转换的内容，以便不将成员传递给您的视图。如果字段名称相同，Automapper 会自动知道要转换什么。