Automapper C# (開発者向けの仕組み)

Automapperの主要な機能

• コードの簡素化: Automapperはプロパティのマッピングを自動化することで手動コードの必要性を大幅に削減し、エラー防止や時間の節約に貢献します。
• マッピング設定の柔軟性: Automapperはマッピング設定の詳細なカスタマイズを可能にし、幅広いマッピングシナリオに対応します。
• パフォーマンス効率: ライブラリは大規模で複雑なオブジェクトモデルを扱うよう設計されており、著しいパフォーマンスのオーバーヘッドを伴いません。

パッケージマネージャーコンソール経由でのインストール

パッケージマネージャーコンソールでシンプルなコマンドを実行することで、プロジェクトに簡単にAutomapperをインストールできます：

Install-Package AutoMapper

基本的なマッピング構成の設定

Automapperを使用する際の基本的なステップは、マッピング構成の定義です。 これは入力オブジェクト（ソース）のプロパティが出力オブジェクト（デスティネーション）にどのように転送されるべきかを指定することを含みます。

var config = new MapperConfiguration(cfg => 
{
    cfg.CreateMap<SourceClass, DestinationClass>();
});
IMapper mapper = config.CreateMapper();

var config = new MapperConfiguration(cfg => 
{
    cfg.CreateMap<SourceClass, DestinationClass>();
});
IMapper mapper = config.CreateMapper();

Dim config = New MapperConfiguration(Sub(cfg)
	cfg.CreateMap(Of SourceClass, DestinationClass)()
End Sub)
Dim mapper As IMapper = config.CreateMapper()

• 上記の例では、SourceClassからDestinationClassへのプロパティマッピングのためにマッピング構成が作成されています。
• この構成を使用してIMapperのインスタンスが作成されます。

複雑なオブジェクトモデルの平坦化

Automapperの強みの一つは、複雑なオブジェクトモデルを平坦化する能力です。 この機能は特にネストされたオブジェクトを扱う場合に有用で、これらのネストされたプロパティをフラットなデスティネーションクラス構造にマッピングすることができます。

多目的なオブジェクトタイプの取り扱い

Automapperはユーザードメインオブジェクト、DTO、さらにはビューモデルを含む様々なオブジェクトタイプ間でのマッピングを巧みに行うことができ、様々なデータ転送ニーズに対応しています。

例1: 単純なマッピング

ユーザーエンティティからユーザーDTOへのプロパティマッピングが必要なシナリオを考えてみましょう：

public class User
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string Address { get; set; }
    public string City { get; set; }
}

public class UserDTO
{
    public string FullName { get; set; }
    public string Address { get; set; }
    public string City { get; set; }
}

// Mapping Configuration
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<User, UserDTO>()
       .ForMember(dest => dest.FullName, opt => opt.MapFrom(src => src.FirstName + " " + src.LastName));
});
IMapper mapper = config.CreateMapper();
User user = new User { FirstName = "John", LastName = "Doe", Address = "123 Street", City = "CityName" };
UserDTO userDto = mapper.Map<UserDTO>(user);

public class User
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string Address { get; set; }
    public string City { get; set; }
}

public class UserDTO
{
    public string FullName { get; set; }
    public string Address { get; set; }
    public string City { get; set; }
}

// Mapping Configuration
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<User, UserDTO>()
       .ForMember(dest => dest.FullName, opt => opt.MapFrom(src => src.FirstName + " " + src.LastName));
});
IMapper mapper = config.CreateMapper();
User user = new User { FirstName = "John", LastName = "Doe", Address = "123 Street", City = "CityName" };
UserDTO userDto = mapper.Map<UserDTO>(user);

Public Class User
	Public Property FirstName() As String
	Public Property LastName() As String
	Public Property Address() As String
	Public Property City() As String
End Class

Public Class UserDTO
	Public Property FullName() As String
	Public Property Address() As String
	Public Property City() As String
End Class

' Mapping Configuration
Private config = New MapperConfiguration(Sub(cfg)
	cfg.CreateMap(Of User, UserDTO)().ForMember(Function(dest) dest.FullName, Function(opt) opt.MapFrom(Function(src) src.FirstName & " " & src.LastName))
End Sub)
Private mapper As IMapper = config.CreateMapper()
Private user As New User With {
	.FirstName = "John",
	.LastName = "Doe",
	.Address = "123 Street",
	.City = "CityName"
}
Private userDto As UserDTO = mapper.Map(Of UserDTO)(user)

• この例は、UserとUserDTO間のマッピングを紹介しており、UserDTOのFullNameはUserのFirstNameとLastNameを連結したものです。

例2: 複雑なオブジェクトを用いた高度なマッピング

より複雑なシナリオとして、ネストされたユーザー詳細を含む注文オブジェクトを簡略化された注文DTOにマッピングしてみましょう：

public class Order
{
    public User OrderedBy { get; set; }
    // Other properties...
}

public class OrderDTO
{
    public string FullName { get; set; }
    // Other properties...
}

// Mapping Configuration
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<Order, OrderDTO>()
       .ForMember(dest => dest.FullName, opt => opt.MapFrom(src => src.OrderedBy.FirstName + " " + src.OrderedBy.LastName));
});
IMapper mapper = config.CreateMapper();
Order order = new Order { OrderedBy = new User { FirstName = "Jane", LastName = "Doe" } };
OrderDTO orderDto = mapper.Map<OrderDTO>(order);

public class Order
{
    public User OrderedBy { get; set; }
    // Other properties...
}

public class OrderDTO
{
    public string FullName { get; set; }
    // Other properties...
}

// Mapping Configuration
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<Order, OrderDTO>()
       .ForMember(dest => dest.FullName, opt => opt.MapFrom(src => src.OrderedBy.FirstName + " " + src.OrderedBy.LastName));
});
IMapper mapper = config.CreateMapper();
Order order = new Order { OrderedBy = new User { FirstName = "Jane", LastName = "Doe" } };
OrderDTO orderDto = mapper.Map<OrderDTO>(order);

Public Class Order
	Public Property OrderedBy() As User
	' Other properties...
End Class

Public Class OrderDTO
	Public Property FullName() As String
	' Other properties...
End Class

' Mapping Configuration
Private config = New MapperConfiguration(Sub(cfg)
	cfg.CreateMap(Of Order, OrderDTO)().ForMember(Function(dest) dest.FullName, Function(opt) opt.MapFrom(Function(src) src.OrderedBy.FirstName & " " & src.OrderedBy.LastName))
End Sub)
Private mapper As IMapper = config.CreateMapper()
Private order As New Order With {
	.OrderedBy = New User With {
		.FirstName = "Jane",
		.LastName = "Doe"
	}
}
Private orderDto As OrderDTO = mapper.Map(Of OrderDTO)(order)

• この例は、OrderedByの詳細を含んだOrderオブジェクトを、ユーザー名を一つのFullNameプロパティに抽出して結合するフラットなOrderDTOにマッピングする方法を示しています。

バージョン9.0では、AutoMapperは静的API (Mapper.Initialize) からインスタンスベースのAPIへ移行しました。 この変更により柔軟性が向上し、依存性注入を使用する現代的なアプリケーションにより適しています。 バージョン9.0より古いバージョンを使用している場合は、静的APIのアプローチが適用されます。 しかし、新しいバージョンについては、上記の例に述べられているようにインスタンスベースのAPIを採用することが推奨されています。

Iron Software Suiteの主要コンポーネント

1. IronPDF for PDF Management: このコンポーネントは開発者にPDFの作成、読み取り、編集、署名の機能を提供します。 HTMLからPDFへの変換機能も提供し、ウェブベースのデータからのレポートや文書の生成に特に便利です。

2. IronXL Excel File Handling: IronXLはOffice Interopを必要とせずにExcelファイルを操作することを可能にし、データ操作と分析タスクを簡素化します。

3. IronOCR for Text Extraction: 画像からのテキスト抽出を可能にし、125の多様な言語をサポートするため、国際プロジェクトに対して非常に汎用性があります。

4. IronBarcode for QR and Barcode Support: QRコードとバーコードの読み取りと書き込みを可能にするライブラリで、在庫管理、追跡、その他関連タスクのための機能を強化します。

Automapperとの補完性

AutomapperがC#における異なるオブジェクトモデル間でのプロパティマッピングに優れている一方で、Iron Softwareのライブラリは様々なデータフォーマットとタイプを扱うためのツールを提供します。例えばAutomapperを使用してユーザードメインオブジェクトをDTOに変換した後、IronPDFを使用してPDF形式の包括的なレポートを生成することができます。 同様に、Automapperを使用して抽出または変換されたデータは、Excelファイル操作のためにIronXLを使用してさらに操作または分析することができます。