受欢迎的博客标签

SubDomain in ASP.NET Core- xxx.domain.com to controller (.Net 2.x)

Published

Asp.net Core version: Asp.net Core  2.x

应用场景:企业门户网站会根据内容不同,设置不同的板块,如新浪有体育,娱乐频道,等等。有的情况下需要给不同的板块设置不同的二级域名,如新浪体育sports.sina.com.cn。

在asp.net core mvc中,如果要实现板块的效果,可能会给不同的板块建立不同的控制器(当然也有其他的技术,这里不讨论实现方式的好坏),在这种情况下,如何给控制器绑定上独有的二级域名,比如体育频道对应的控制器叫SportController,通过sports.XXX.com域名访问系统的时候,直接进入SportController,并且通过这个二级域名无法访问其他的控制器。

上面说完场景了,下面来看下如何实现。

在asp.net core mvc中有路由规则配置,配置的地方在Startup.Configure方法中,具体代码如下:

1
2
3
4
5
6
7
app.UseMvc(routes =>
{
      routes.MapRoute(
           name: "default",
           template: "{controller=Home}/{action=Index}/{id?}",
           defaults: new { area="admin"});
});

遗憾的是不支持对域名的支持(我目前了解的是,如果有问题,欢迎大家指正)。通过routes.MapRouter注册路由规则,并加入到RouteCollection中,当某个请求过来后,RouterCollection循环所有注册好的IRouter对象,找到第一个匹配的IRouter为止。虽然框架不支持域名配置规则,但是我们可以自己去实现一个IRouter,在里面实现二级域名判断的逻辑,我这里暂时起名为SubDomainRouter,具体实现代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
public class SubDomainRouter : RouteBase
  {
      private readonly IRouter _target;
      private readonly string _subDomain;
      public SubDomainRouter(
         IRouter target,
         string subDomain,//当前路由规则绑定的二级域名
         string routeTemplate,
         RouteValueDictionary defaults,
         RouteValueDictionary constrains,
         IInlineConstraintResolver inlineConstraintResolver)
         base(routeTemplate,
                subDomain,
                inlineConstraintResolver,
                defaults,
                constrains,
                new RouteValueDictionary(null))
      {
          if (target == null)
          {
              throw new ArgumentNullException(nameof(target));
          }
          if (subDomain == null)
          {
              throw new ArgumentNullException(nameof(subDomain));
          }
          _subDomain = subDomain;
          _target = target;
      }
      public override Task RouteAsync(RouteContext context)
      {
          string domain = context.HttpContext.Request.Host.Host;//获取当前请求域名,然后跟_subDomain比较,如果不想等,直接忽略
          
          if (string.IsNullOrEmpty(domain) || string.Compare(_subDomain, domain) != 0)
          {
              return Task.CompletedTask;
          }
      
     //如果域名匹配,再去验证访问路径是否匹配
 
          return base.RouteAsync(context);
           
      }
 
      protected override Task OnRouteMatched(RouteContext context)
      {
          context.RouteData.Routers.Add(_target);
          return _target.RouteAsync(context);
      }
 
      protected override VirtualPathData OnVirtualPathGenerated(VirtualPathContext context)
      {
          return _target.GetVirtualPath(context);
      }
  }

从上面的代码我们只看到了域名检测,但是如何把域名定向到特定的控制器上,这就需要我们在注册这个IRouter的时候做些文章,直接上代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
public static class RouteBuilderExtensions
    {
        public static IRouteBuilder MapDomainRoute(
            this IRouteBuilder routeBuilder,string domain,string area,string controller)
        {
            if(string.IsNullOrEmpty(area)||string.IsNullOrEmpty(controller))
            {
                throw new ArgumentNullException("area or controller can not be null");
            }
            var inlineConstraintResolver = routeBuilder
                .ServiceProvider
                .GetRequiredService<IInlineConstraintResolver>();
 
                string template = "";
 
                    RouteValueDictionary defaults = new RouteValueDictionary();
                    RouteValueDictionary constrains = new RouteValueDictionary();
                    constrains.Add("area", area);
                    defaults.Add("area", area);
                    constrains.Add("controller", controller);
                    defaults.Add("controller"string.IsNullOrEmpty(controller) ? "home" : controller);
                    defaults.Add("action""index");
                     
                    template += "{action}/{id?}";//路径规则中不再包含控制器信息,但是上面通过constrains限定了查找时所要求的控制器名称
                    routeBuilder.Routes.Add(new SubDomainRouter(routeBuilder.DefaultHandler, domain, template, defaults, constrains, inlineConstraintResolver));
 
             
            return routeBuilder;
        }
}

最后我们就可以在Startup中注册对应的规则,如下:

1
2
3
4
5
6
7
8
9
10
app.UseMvc(
      routes =>
        {
            routes.MapDomainRoute("xxx.domain.com","areaname","controllername");
                         
            routes.MapRoute(
                  name: "default",
                  template: "{controller=Home}/{action=Index}/{id?}",
                  defaults: new { area = "web" });
        });