2018年9月22日土曜日

ASP.NET MVC 5 OracleのテーブルからEDMを作成するとき、Numerの精度によりint以外にマッピングされる

VisualStudio2017 / ASP.NET MVC 5 / Framework4.6.2 / C# / Oracle.ManagedDataAccess.EntityFramework 12.2.1100


データベースファーストでOracleのテーブルよりEDMを作成すると、Numerの精度により以下のようにマップされます。
Number(1,0)bool
Number(2,0) ~ Number(3,0)byte
Number(4,0)int16
Number(5,0) ~ Number(9,0)int32
Number(10,0) ~ Number(18,0)int64


Numberの精度がNumber(1,0)~Numebre(4,0)の場合に int16 にマップするには、web.config に
<add NETType="int16" MinPrecision="1" MaxPrecision="4" DBType="Number"/>
を追加します。

Web.config
<oracle.manageddataaccess.client>
 <version number="*">
  <edmMappings>
   <edmNumberMapping>
    <add NETType="int16" MinPrecision="1" MaxPrecision="4" DBType="Number"/>
   </edmNumberMapping>
  </edmMappings>
  <dataSources>
   <dataSource alias="XXXXX" descriptor="(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=XXX.XXX.XXX.XXX)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=XXXXX))) " />
  </dataSources>
 </version>
</oracle.manageddataaccess.client>

2018年9月15日土曜日

ASP.NET MVC EditorForでhtmlAttributesを指定せずにclassを指定する

VisualStudio2017 / ASP.NET MVC 5 / Framework4.6.2 / C#


EditorForでclass属性を指定するには、htmlAttributes を使って下記のように書きます
@Html.EditorFor(mdl => mdl.ID, new { htmlAttributes = new { @class = "form-control" } })
少しの事なんだけどメンドクサイ…

EditorForを拡張したEditForExを作成し、htmlAttributesを指定せずにclass属性を設定できるようにしたいと思います。
こんな感じで設定できるようにします。
@Html.EditorForEx(mdl => mdl.ID, new { @class = "form-control" } )

カスタムヘルパーの作成

カスタムヘルパーEitorForExを作成します。
htmlAttributes属性はヘルパーの中でつけてあげます。

EitorForExヘルパーを使用したとき何か固定で付けたい属性があれば、指定しておきます。
Bootstrapを使用しているのであれば「form-control」を付けておいてもいいかもしれません。

また、通常のEditorForヘルパーはclass属性に「text-box single-line」を吐き出すので、これを出力しないようにします。

using System;
using System.Linq.Expressions;
using System.Web;
using System.Web.Mvc;
using System.Web.Mvc.Html;
using System.Web.Routing;

using MyApp.Addon.Attributes;


namespace MyApp.Addon.Extentions
{
    /// 
    /// HTMLヘルパーに対する拡張クラス
    /// 
    public static class HtmlHelperEx
    {

        /// 
        /// EditorForヘルパーを拡張したヘルパー
        /// 機能
        /// htmlAttributesの指定なしにclass属性を指定する
        /// class属性にハードコーディングされる「text-box single-line」を削除する
        /// 
        /// 
        /// 
        /// 
        /// 
        /// 
        public static IHtmlString EditorForEx<TModel, TValue>(this HtmlHelper<TModel> htmlHelper, 
                                                                Expression<Func<TModel, TValue>> expression, 
                                                                object viewData)
        {
            //属性をディクショナリに変換
            var dicAttr = new RouteValueDictionary(viewData);
            
      //何か固定で足したい属性があればここで足す
            //属性を追加
            dicAttr.Add("maxlength", 10);

            /*
             * EditorForヘルパーでHTML属性を指定するには
             * @Html.EditorFor(mdl => mdl.ID, new { htmlAttributes = new { @class = "form-control", @readonly="readonly" } } )
             * と指定しなければならない。
             * 
             * これをEditorForExヘルパーでは
             * @Html.EditorFor(mdl => mdl.ID, new { @class = "form-control", @readonly="readonly" } )
             * と指定できるようにする。
             */
            dynamic htmlAttr = new { htmlAttributes = dicAttr };
            MvcHtmlString hstr = htmlHelper.EditorFor(expression, (object)htmlAttr);


            /*
             * 吐き出されるHtmlより class=属性の「text-box single-line」を外す
             */
            hstr = MvcHtmlString.Create(hstr.ToString().Replace(" text-box single-line", ""));
            
            return hstr;
        }

    }
}
よく使用するヘルパーであれば、Views/Web.configのnamespace要素に追加すると、各ビューにインポートを書かなくて済みます。
web.configに追加した場合、私の環境ではVisualStudioを再起動しないと、ビューで使用する際にコンパイルエラーになりました。

        
       ・・・省略
        

web.configに追加しない場合は、各ビューの先頭でインポートしてください。
@using MyApp.Addon.Extentions;

通常のEditorFor と 今回作成したEditorForExの出力をみてみます。
EditorFor
@Html.EditorFor(mdl => mdl.ID, new { htmlAttributes = new { @class = "form-control" } })

出力結果:

EditorForEx
@Html.EditorForEx(mdl => mdl.ID, new { @class = "form-control" })
出力結果


ASP.NET MVC 自作カスタム属性を、自作Htmlヘルパーでビューに表示する

VisualStudio2017 / ASP.NET MVC 5 / Framework4.6.2 / C#


ビューモデルのプロパティに指定した「Placeholder」カスタム属性の値を、「PlaceHolderFor」カスタムヘルパーでビューに出力できるようにします。

目指すゴールは
ビューモデルのプロパティにPlaceholder属性を設定し、プレースホルダーに表示する値を指定できるようにします。
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using MyApp.Addon.Attributes;

namespace MyApp.ViewModels
{
    /// 
    /// ログイン ビューモデル
    /// 
    public class Login
    {
        [DisplayName("ID"),
         Placeholder("IDを入力してください")]
        public string ID { get; set; }
    }
} 

次にビューでは @Html.PlaceholderFor ヘルパーを使用して、プレースホルダーの値を表示できるようにします。
@Html.EditorFor(mdl => mdl.ID, new { htmlAttributes = new { @class = "form-control", placeholder = @Html.PlaceholderFor(mdl => mdl.ID) } })

カスタム属性の作成

まずはPlaceHolder属性から作成していきます。
Placeholder属性では、プレースホルダーに表示する値をコンストラクタの引数で指定するようにしています。
モデルのプロパティに対して使用する属性なので、クラスに System.AttributeUsage(AttributeTargets.Property) 属性を指定します。
using System;

namespace MyApp.Addon.Attributes
{
    /// 
    /// プレースホルダー属性
    /// 
    [System.AttributeUsage(AttributeTargets.Property)]
    public class PlaceholderAttribute : System.Attribute 
    {
        /// 
        /// プレースホルダーとして表示値する値
        /// 
        public string DisplayValue { get; set; }

        /// 
        /// コンストラクタ
        /// 
        /// プレースホルダーとして表示する値
        public PlaceholderAttribute(string displayValue)
        {
            DisplayValue = displayValue;
        }
    }
}
次に属性を読み取るモデルメタデータプロバイダーを作成します。
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Mvc;


namespace MyApp.Addon.Attributes
{
    /// 
    /// 拡張したモデルメタデータプロバイダー
    /// 
    /// 
    /// Global.asaxのApplication_Start()で、モデルプロバイダーに指定する。
    /// 
    public class ModelMetadataProvidersEx : DataAnnotationsModelMetadataProvider
    {
        /// 
        /// 基底のCreateMetadataをオーバーライド
        /// 指定したモデルのメタデータを作成します。
        /// 
        /// 属性
        /// コンテナーの型。コンテナーが存在しない場合は null。
        /// モデル アクセサー。
        /// モデルの型。
        /// プロパティ名。モデルがプロパティではない場合は、null。
        /// モデルのメタデータ
        protected override ModelMetadata CreateMetadata(IEnumerable attributes, Type containerType, Func<object> modelAccessor, Type modelType, string propertyName)
        {
            //元のCreateMetadataメソッドを呼び出し
            ModelMetadata metadata = base.CreateMetadata(attributes, containerType, modelAccessor, modelType, propertyName);
            //Placeholder属性を追加する
            PlaceholderAttribute pha = attributes.OfType<PlaceholderAttribute>().FirstOrDefault();
            if (pha != null)
            {
                metadata.AdditionalValues.Add("Placeholder", pha);
            }
            
            return metadata;
        }
    }
}
作成したモデルメタデータプロバイダーを、Grobal.asaxのApplication_Startメソッドで、属性の読み取りに使用する設定を行います。
using System.Web.Mvc;
using System.Web.Routing;

namespace MyApp
{
    /// 
    /// アプリケーションイベント
    /// 
    public class MvcApplication : System.Web.HttpApplication
    {
        /// 
        /// アプリケーション起動時
        /// 
        protected void Application_Start()
        {
            //エリア登録
            AreaRegistration.RegisterAllAreas();
            //ルート登録
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            //データアノテーション属性の読み込みに、カスタマイズしたプロバイダーを使用する
            ModelMetadataProviders.Current = new MyApp.Addon.Attributes.ModelMetadataProvidersEx();
        }
        
    }
}
以上で属性の作成は終了です。
リビルドしたら、ビューモデルのプロパティに対して、プレースホルダーの属性を設定します。
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using MyApp.Addon.Attributes;

namespace MyApp.ViewModels
{
    /// 
    /// ログイン ビューモデル
    /// 
    public class Login
    {
        [DisplayName("ID"),
         Placeholder("IDを入力してください")]
        public string ID { get; set; }
    }
} 

カスタムHtmlヘルパーの作成

次にプレースホルダーの属性値を表示するためのHtmlヘルパーを作成します。
using System;
using System.Linq.Expressions;
using System.Web;
using System.Web.Mvc;
using System.Web.Mvc.Html;
using System.Web.Routing;
using System.Dynamic;

using MyApp.Addon.Attributes;


namespace MyApp.Addon.Extentions
{
    /// 
    /// HTMLヘルパーに対する拡張クラス
    /// 
    public static class HtmlHelperEx
    {
       
        /// 
        /// PlaceholderFor プレースホルダー属性に指定された値を出力するHtmlヘルパー
        /// 
        /// 
        /// 
        /// 
        /// 
        /// 
        public static IHtmlString PlaceholderFor<TModel, TValue>(
                             this HtmlHelper<TModel> htmlHelper,
                             Expression<Func<TModel, TValue>> expression)
        {

            var attrList = ModelMetadata.FromLambdaExpression<TModel, TValue>(expression, htmlHelper.ViewData);
            //プレースホルダーの属性値を返す
            if (attrList.AdditionalValues.ContainsKey("Placeholder"))
            {
                var plhAttr = (PlaceholderAttribute)attrList.AdditionalValues["Placeholder"];
                return new HtmlString(plhAttr.DisplayValue);
            }
            return new HtmlString("");
        }

        

    }
}

以上でヘルパーの作成は終了です。


よく使用するヘルパーであれば、Views/Web.configのnamespace要素に追加すると、各ビューにインポートを書かなくて済みます。
web.configに追加した場合、私の環境ではVisualStudioを再起動しないと、ビューで使用する際にコンパイルエラーになりました。

        
       ・・・省略
        

web.configに追加しない場合は、各ビューの先頭でインポートしてください。
@using MyApp.Addon.Extentions;
これでビューでは @Html.PlaceholderFor ヘルパーを使用して、プレースホルダーの値を表示できるようになります。
@Html.EditorFor(mdl => mdl.ID, new { htmlAttributes = new { @class = "form-control", placeholder = @Html.PlaceholderFor(mdl => mdl.ID) } })

実行結果

2018年9月8日土曜日

ASP.NET MVC データベースファーストでOracleのテーブルからEDMが作成できない

Visual Studio 2017
Framework 4.6.2
ASP.NET MVC 5

上記の条件でORACLEのテーブルからEDMを作成しようとしたのですが、EDM作成ウィザードが途中で消えてしまう現象が発生しました。

VisualStudio2017でFramework4.6.2を選択し空のASP.NET MVCアプリケーションを作成しました。


NuGetからEntityFrameworkをインストールします。
2018/09/08時点で最新の安定版6.2.0です。

NuGetからOriole.Managed.DataAccess.EntityFrameworkをインストールします。
2018/09/08時点で最新の安定版18.3.0です。


Oracleのサイトから32-bit Oracle Data Access Components (ODAC) with Oracle Developer Tools for Visual Studio をダウンロードしてインストールします。
2018/09/08時点で最新バージョンの12.2.0.1.1です。

EDMを追加します。
適当なフォルダで右クリックし「追加」>「新しい項目」を選択し「ADO .NET Entity Data Model」を選択します。
Entity Data Model ウィザードが起動するので、設定を進めていきます。




本当なら次にデータベースのテーブルを選択する画面が出てくるのですが、ウィザードはここで終了してしまいます。

色々ためしてみましたが、NuGetからインストールしたOriole.Managed.DataAccess.EntityFrameworkを、 最新の安定版18.3.0 から ひとつ前のバージョン12.2.1100に落とすとウィザードが正常に動きました。

同じようにEDM作成ウィザードを起動すると、次はテーブルを選択する画面が出てきました。