More than 5 years have passed since last update.

【ASP.NET Core入門記】データファーストでScaffoldする【MVC】

Last updated at 2017-08-29Posted at 2017-01-10

【ASP.NET Core入門記】データファーストでScaffoldする【MVC】

目的

EntityFrameworkCoreのScaffold機能を利用して、データベースの内容から
データを操作する__CRUD Webアプリケーションを自動生成__します。

Scaffoldって？

「Scaffold」とは「足場」という意味で、データベースの基本操作に
必要な機能の骨組みを自動生成する機能のことを指します。

データベースの基本操作（CRUD）とは、

Create（行の作成⇒INSERT）
Read（行の参照⇒SELECT）
Update（行の更新⇒UPDATE）
Delete（行の削除⇒DELETE）

のことを指し、DB上のエンティティに対する操作を行うWebアプリケーションを、
自動的に生成することが出来ます。

環境

Windows10 Anniversary Update
Microsoft SqlServer 2014
Microsoft VisualStudio2015

手順

データベースの作成

SqlServerで適当なデータベースを作成します。
ここでは、データベース名を「ScaffoldDB」とします。
```
CREATE DATABASE ScaffoldDB
```

作成したDBにテーブルを追加します。
ここでは、「社員」を管理するpersonテーブルと、
「所属」を管理する「department」テーブルの２つを作成します。
SQLの細かい内容についてはここでは触れません。

CREATE TABLE person (
    id int IDENTITY(1,1) NOT NULL,
    name VARCHAR(50) NOT NULL,
    age int NOT NULL,
    dep_id int NOT NULL
    CONSTRAINT PK_Person1 PRIMARY KEY CLUSTERED
    (
        id ASC
    )
)

CREATE TABLE department (
    id int IDENTITY(1,1) NOT NULL,
    name VARCHAR(50) NOT NULL,
    CONSTRAINT PK_Department PRIMARY KEY CLUSTERED
    (
        id ASC
    )
)

作成した２つのテーブルにリレーションを結びます。
personテーブルのdep_idから、depertmentテーブルのidを参照できるようにします。
```
ALTER TABLE person    
ADD CONSTRAINT FK_Person_Department FOREIGN KEY (dep_id)     
    REFERENCES Department (id);
```
SqlServer Management Studioからデータベースダイアグラムを確認し、
２つのテーブルが正しいリレーションで結ばれていることを確認します。

作成したテーブルにテストデータを挿入します。

INSERT INTO department VALUES('営業部');
INSERT INTO department VALUES('開発部');

INSERT INTO person VALUES('yamada',30,2);
INSERT INTO person VALUES('yoshida',35,1);

プロジェクトの作成

プロジェクトの作成には、コマンドラインから作成するパターンと、
VisualStudio2015からウィザードを用いて作成するパターンの２つがありますが、
今回はVisualStudio2015からウィザードを用いて作成します。

コマンドラインを用いて作成するパターンは、こちらの記事を参考にして下さい。

【ASP.NET Core】PowerShellからScaffoldする【MVC】
http://qiita.com/logikuma/items/95af749cd387cb71a4a0

VisualStudio2015を起動し、「ファイル」＞「新規」＞「新しいプロジェクト」から、
「ASP.NET Core Web Application (.NET Core)」を選択します。
名前は「ScaffoldTest」とします。
テンプレート選択画面となるので、Webアプリケーションを選択し、
「認証の変更」ボタンから「個別のユーザーアカウント」を選択します。
これにより、ローカルデータベースへのアクセスに必要なプロジェクト情報を、
VisualStudioが自動的に作成してくれます。

モデルの自動生成

モデルの作成には、Windows Powershellからdotnet efコマンドを発行します。

ソリューションエクスプローラ上のプロジェクトルート（ScaffoldTest）をクリックし、
下部ウィンドウ内にある「プロパティ」からフォルダパスを取得します。
取得したフォルダパスをエクスプローラで開き、エクスプローラ上から
Powershellを起動します。

エクスプローラのディレクトリ表示部分に「powershell」と入力すると、
そのディレクトリ上でPowershellが起動されます。
Powershellから下記コマンドを実行します。
```
dotnet ef dbcontext scaffold "Server=データベースサーバ名;Database=ScaffoldDB;Trusted_Connection=True" Microsoft.EntityFrameworkCore.SqlServer -o Models
```
EntityFrameworkのscaffold機能を用いて、DIクラスとなるdbContextを自動的に生成し、
そのデータベース内にあるテーブルをモデルクラスとしてC#のコードに自動生成します。
新しく生成されたModelsパッケージの中を見てみると、Person.cs、Depatment.cs、
ScaffoldDBContext.csが生成されています。

コントローラ・ビューの自動生成

作成したモデルを用いて、コントローラ・ビューも自動生成することが出来ます。
これにより、データのみ作成するだけでCRUDアプリケーションを作成することが出来ます。

ソリューションエクスプローラからControllersを右クリックし、
「追加」＞「新規スキャフォールディングアイテム」を選択します。
「MVC Controller with views, using Entity Framework」を選択し、
追加ボタンをクリックします。
コントローラの追加ダイアログが表示されるので、モデルクラスにPerson、
データコンテキストクラスにScaffoldDBContextを指定、
コントローラ名は複数形にする決まりがあるので、PeopleControllerにして追加をクリックします。

Startup.csを修正します。Startup.cs > ConfigureServiceメソッド内に一行追加します。

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.
    services.AddApplicationInsightsTelemetry(Configuration);

    services.AddDbContext<ApplicationDbContext>(options =>
        options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));

    services.AddIdentity<ApplicationUser, IdentityRole>()
        .AddEntityFrameworkStores<ApplicationDbContext>()
        .AddDefaultTokenProviders();
    
    //DBContextを読み込む
    services.AddDbContext<ScaffoldDBContext>(); // この行を追加

    services.AddMvc();

    // Add application services.
    services.AddTransient<IEmailSender, AuthMessageSender>();
    services.AddTransient<ISmsSender, AuthMessageSender>();
}