web-dev-qa-db-ja.com

ASP.NET MVCで「ビューを検索」するカスタムの場所を指定できますか？

私のmvcプロジェクトのレイアウトは次のとおりです。

  • /Controllers
    • /デモ
    • / Demo/DemoArea1Controller
    • / Demo/DemoArea2Controller
    • 等...
  • /ビュー
    • /デモ
    • /Demo/DemoArea1/Index.aspx
    • /Demo/DemoArea2/Index.aspx

ただし、DemoArea1Controller：

public class DemoArea1Controller : Controller
{
    public ActionResult Index()
    {
        return View();
    }
}

通常の検索場所で、「ビュー 'インデックス'またはそのマスターが見つかりませんでした」というエラーが表示されます。

「デモ」ビューのサブフォルダの「デモ」名前空間検索でコントローラを指定するにはどうすればよいですか？

asp.net-mvcviews
102
Daniel Schaffer

WebFormViewEngineを簡単に拡張して、見たい場所をすべて指定できます。

public class CustomViewEngine : WebFormViewEngine
{
    public CustomViewEngine()
    {
        var viewLocations =  new[] {  
            "~/Views/{1}/{0}.aspx",  
            "~/Views/{1}/{0}.ascx",  
            "~/Views/Shared/{0}.aspx",  
            "~/Views/Shared/{0}.ascx",  
            "~/AnotherPath/Views/{0}.ascx"
            // etc
        };

        this.PartialViewLocationFormats = viewLocations;
        this.ViewLocationFormats = viewLocations;
    }
}

Global.asax.csのApplication_Startメソッドを変更して、ビューエンジンを登録することを忘れないでください。

protected void Application_Start()
{
    ViewEngines.Engines.Clear();
    ViewEngines.Engines.Add(new CustomViewEngine());
}
119
Sam Wessel

MVC 6では、ビューエンジンをいじらずにIViewLocationExpanderインターフェイスを実装できます。

_public class MyViewLocationExpander : IViewLocationExpander
{
    public void PopulateValues(ViewLocationExpanderContext context) {}

    public IEnumerable<string> ExpandViewLocations(ViewLocationExpanderContext context, IEnumerable<string> viewLocations)
    {
        return new[]
        {
            "/AnotherPath/Views/{1}/{0}.cshtml",
            "/AnotherPath/Views/Shared/{0}.cshtml"
        }; // add `.Union(viewLocations)` to add default locations
    }
}
_

ここで、_{0}_はターゲットビュー名、_{1}_-コントローラ名、_{2}_-エリア名です。

独自の場所のリストを返すか、デフォルトのviewLocations（.Union(viewLocations)）とマージするか、単に変更する（viewLocations.Select(path => "/AnotherPath" + path)）ことができます。

MVCでカスタムビューロケーションエキスパンダーを登録するには、次の行を_Startup.cs_ファイルのConfigureServicesメソッドに追加します。

_public void ConfigureServices(IServiceCollection services)
{
    services.Configure<RazorViewEngineOptions>(options =>
    {
        options.ViewLocationExpanders.Add(new MyViewLocationExpander());
    });
}
_
43
whyleee

実際には、パスをコンストラクターにハードコーディングするよりもはるかに簡単な方法があります。以下は、Razorエンジンを拡張して新しいパスを追加する例です。ここで追加するパスがキャッシュされるかどうかについては、完全にはわかりません。

public class ExtendedRazorViewEngine : RazorViewEngine
{
    public void AddViewLocationFormat(string paths)
    {
        List<string> existingPaths = new List<string>(ViewLocationFormats);
        existingPaths.Add(paths);

        ViewLocationFormats = existingPaths.ToArray();
    }

    public void AddPartialViewLocationFormat(string paths)
    {
        List<string> existingPaths = new List<string>(PartialViewLocationFormats);
        existingPaths.Add(paths);

        PartialViewLocationFormats = existingPaths.ToArray();
    }
}

Global.asax.cs

protected void Application_Start()
{
    ViewEngines.Engines.Clear();

    ExtendedRazorViewEngine engine = new ExtendedRazorViewEngine();
    engine.AddViewLocationFormat("~/MyThemes/{1}/{0}.cshtml");
    engine.AddViewLocationFormat("~/MyThemes/{1}/{0}.vbhtml");

    // Add a shared location too, as the lines above are controller specific
    engine.AddPartialViewLocationFormat("~/MyThemes/{0}.cshtml");
    engine.AddPartialViewLocationFormat("~/MyThemes/{0}.vbhtml");

    ViewEngines.Engines.Add(engine);

    AreaRegistration.RegisterAllAreas();
    RegisterRoutes(RouteTable.Routes);
}

注意すべき点が1つあります。カスタムの場所には、ルートにViewStart.cshtmlファイルが必要です。

40
Chris S

新しいパスを追加するだけの場合は、デフォルトのビューエンジンに追加して、コードの数行を節約できます。

ViewEngines.Engines.Clear();
var razorEngine = new RazorViewEngine();
razorEngine.MasterLocationFormats = razorEngine.MasterLocationFormats
      .Concat(new[] { 
          "~/custom/path/{0}.cshtml" 
      }).ToArray();

razorEngine.PartialViewLocationFormats = razorEngine.PartialViewLocationFormats
      .Concat(new[] { 
          "~/custom/path/{1}/{0}.cshtml",   // {1} = controller name
          "~/custom/path/Shared/{0}.cshtml" 
      }).ToArray();

ViewEngines.Engines.Add(razorEngine);

同じことがWebFormEngineにも当てはまります

22
Marcelo De Zen

RazorViewEngineをサブクラス化するか、完全に置き換える代わりに、既存のRazorViewEngineのPartialViewLocationFormatsプロパティを変更できます。このコードはApplication_Startにあります。

System.Web.Mvc.RazorViewEngine rve = (RazorViewEngine)ViewEngines.Engines
  .Where(e=>e.GetType()==typeof(RazorViewEngine))
  .FirstOrDefault();

string[] additionalPartialViewLocations = new[] { 
  "~/Views/[YourCustomPathHere]"
};

if(rve!=null)
{
  rve.PartialViewLocationFormats = rve.PartialViewLocationFormats
    .Union( additionalPartialViewLocations )
    .ToArray();
}
13
Simon Giles

注：ASP.NET MVC 2の場合、「エリア」のビューに設定する必要がある追加のロケーションパスがあります。

 AreaViewLocationFormats
 AreaPartialViewLocationFormats
 AreaMasterLocationFormats

エリアのビューエンジンの作成は Philのブログで説明されています です。

注：これはプレビューリリース1用であるため、変更される可能性があります。

3
Simon_Weaver

次のようなものを試してください：

private static void RegisterViewEngines(ICollection<IViewEngine> engines)
{
    engines.Add(new WebFormViewEngine
    {
        MasterLocationFormats = new[] {"~/App/Views/Admin/{0}.master"},
        PartialViewLocationFormats = new[] {"~/App/Views/Admin//{1}/{0}.ascx"},
        ViewLocationFormats = new[] {"~/App/Views/Admin//{1}/{0}.aspx"}
    });
}

protected void Application_Start()
{
    RegisterViewEngines(ViewEngines.Engines);
}
3
Vitaliy Ulantikov

最後に確認しましたが、これには独自のViewEngineを構築する必要があります。 RC1で簡単になったかどうかはわかりませんが。

最初のRCの前に使用した基本的なアプローチは、自分のViewEngineで、コントローラーの名前空間を分割し、パーツに一致するフォルダーを探すことでした。

編集：

戻ってコードを見つけました。一般的な考え方は次のとおりです。

public override ViewEngineResult FindView(ControllerContext controllerContext, string viewName, string masterName)
{
    string ns = controllerContext.Controller.GetType().Namespace;
    string controller = controllerContext.Controller.GetType().Name.Replace("Controller", "");

    //try to find the view
    string rel = "~/Views/" +
        (
            ns == baseControllerNamespace ? "" :
            ns.Substring(baseControllerNamespace.Length + 1).Replace(".", "/") + "/"
        )
        + controller;
    string[] pathsToSearch = new string[]{
        rel+"/"+viewName+".aspx",
        rel+"/"+viewName+".ascx"
    };

    string viewPath = null;
    foreach (var path in pathsToSearch)
    {
        if (this.VirtualPathProvider.FileExists(path))
        {
            viewPath = path;
            break;
        }
    }

    if (viewPath != null)
    {
        string masterPath = null;

        //try find the master
        if (!string.IsNullOrEmpty(masterName))
        {

            string[] masterPathsToSearch = new string[]{
                rel+"/"+masterName+".master",
                "~/Views/"+ controller +"/"+ masterName+".master",
                "~/Views/Shared/"+ masterName+".master"
            };


            foreach (var path in masterPathsToSearch)
            {
                if (this.VirtualPathProvider.FileExists(path))
                {
                    masterPath = path;
                    break;
                }
            }
        }

        if (string.IsNullOrEmpty(masterName) || masterPath != null)
        {
            return new ViewEngineResult(
                this.CreateView(controllerContext, viewPath, masterPath), this);
        }
    }

    //try default implementation
    var result = base.FindView(controllerContext, viewName, masterName);
    if (result.View == null)
    {
        //add the location searched
        return new ViewEngineResult(pathsToSearch);
    }
    return result;
}
3
Joel