.net core實現跨域

什麼是跨域在前面已經講解過了,這裏便再也不講解,直接上代碼。html

1、後臺API接口

用.net core建立一個Web API項目負責給前端界面提供數據。前端

2、前端界面

創建兩個MVC項目,模擬不一樣的ip,在view裏面添加按鈕調用WEB API提供的接口進行測試跨域。view視圖頁代碼以下:jquery

@{
    Layout = null;
}

<!DOCTYPE html>

<html>
<head>
    <meta name="viewport" content="width=device-width" />
    <title>跨域測試1</title>
    <script src="~/Scripts/jquery-1.10.2.js"></script>
    <script>
        function btnGet() {
            $.ajax({
                url: 'https://localhost:44355/api/values',
                type: "Get",
                dataType: "json",
                success: function (data) {
                    alert("成功");
                },
                error: function (data) {
                    alert("失敗");
                }
            });
        }
    </script>
</head>
<body>
    <div> 
        <input type="button" id="btn" value="測試跨域" onclick="btnGet()" />
    </div>
</body>
</html>

3、測試

一、不設置容許跨域

首先,先不設置.net core容許跨域,查看調用效果:ajax

點擊測試跨域1按鈕:json

F12進入Debug模式查看失敗緣由:api

從這裏能夠看出來是由於產生了跨域問題,因此會失敗。跨域

點擊測試跨域2的效果和此效果一致。數組

二、設置容許全部來源跨域

2.一、在StartUp類的ConfigureServices方法中添加以下代碼:app

// 配置跨域處理,容許全部來源
services.AddCors(options =>
options.AddPolicy("cors",
p => p.AllowAnyOrigin().AllowAnyHeader().AllowAnyMethod().AllowCredentials()));

 2.二、修改Configure方法cors

// 容許全部跨域,cors是在ConfigureServices方法中配置的跨域策略名稱
app.UseCors("cors");

 2.三、測試

 

從截圖中能夠看出,此次調用成功了。

三、設置特定來源能夠跨域

3.一、修改ConfigureServices方法代碼以下:

//容許一個或多個來源能夠跨域
services.AddCors(options =>
{
      options.AddPolicy("CustomCorsPolicy", policy =>
      {
             // 設定容許跨域的來源,有多個能夠用','隔開
             policy.WithOrigins("http://localhost:21632")
             .AllowAnyHeader()
             .AllowAnyMethod()
             .AllowCredentials();
      });
});

 這裏設置只容許ip爲http://localhost:21632的來源容許跨域。

3.二、修改Configure代碼以下:

// 設定特定ip容許跨域 CustomCorsPolicy是在ConfigureServices方法中配置的跨域策略名稱
app.UseCors("CustomCorsPolicy");

 3.3測試

點擊跨域測試1按鈕,結果以下:

能夠看到訪問成功了,而後在點擊跨域測試2按鈕,結果以下:

發現此次訪問失敗了,F12進入Debug模式,查看失敗緣由:

從截圖中能夠看出是由於這裏產生了跨域請求,可是沒有容許跨域測試2所在的ip跨域。那麼若是也想讓跨域測試2能夠調用成功該怎麼辦呢?

光標定位到WithOrigins上面,而後F12查看定義:

從截圖中發現:WithOrigins的參數是一個params類型的字符串數組,若是要容許多個來源能夠跨域,只要傳一個字符串數組就能夠了,因此代碼修改以下:

//容許一個或多個來源能夠跨域
services.AddCors(options =>
{
      options.AddPolicy("CustomCorsPolicy", policy =>
      {
            // 設定容許跨域的來源,有多個能夠用','隔開
            policy.WithOrigins("http://localhost:21632", "http://localhost:24661")
            .AllowAnyHeader()
            .AllowAnyMethod()
            .AllowCredentials();
      });
});

 這時跨域測試2也能夠調用成功了

四、優化

在上面的例子中,須要分兩步進行設置才能夠容許跨域,有沒有一種方法只須要設置一次就能夠呢?在Configure方法中只設置一次便可,代碼以下:

// 設置容許全部來源跨域
app.UseCors(options =>
{
       options.AllowAnyHeader();
       options.AllowAnyMethod();
       options.AllowAnyOrigin();
       options.AllowCredentials();
});

// 設置只容許特定來源能夠跨域
app.UseCors(options =>
{
        options.WithOrigins("http://localhost:3000", "http://127.0.0.1"); // 容許特定ip跨域
        options.AllowAnyHeader();
        options.AllowAnyMethod();
        options.AllowCredentials();
});

五、利用配置文件實現跨域

在上面的示例中,都是直接把ip寫在了程序裏面,若是要增長或者修改容許跨域的ip就要修改代碼,這樣很是不方便,那麼能不能利用配置文件實現呢?看下面的例子。

5.一、修改appsettings.json文件以下:

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": {
    "url": "http://localhost:21632|http://localhost:24663"
  }
}

AllowedHosts裏面設置的是容許跨域的ip,多個ip直接用「|」進行拼接,也能夠用其餘符合進行拼接。

5.二、增長CorsOptions實體類

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace CorsDomainDemo
{
    public class CorsOptions
    {
        public string url { get; set; }
    }
}

 

5.三、 新增OptionConfigure方法

private void OptionConfigure(IServiceCollection services)
{
    services.Configure<CorsOptions>(Configuration.GetSection("AllowedHosts"));
}

 

5.四、在ConfigureServices方法裏面調用OptionConfigure方法

// 讀取配置文件內容
OptionConfigure(services);

 

5.五、修改Configure方法,增長IOptions<CorsOptions>類型的參數,最終代碼以下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;

namespace CorsDomainDemo
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            // 配置跨域處理,容許全部來源
            //services.AddCors(options =>
            //options.AddPolicy("cors",
            //p => p.AllowAnyOrigin().AllowAnyHeader().AllowAnyMethod().AllowCredentials()));

            //容許一個或多個來源能夠跨域
            //services.AddCors(options =>
            //{
            //    options.AddPolicy("CustomCorsPolicy", policy =>
            //    {
            //        // 設定容許跨域的來源,有多個能夠用','隔開
            //        policy.WithOrigins("http://localhost:21632", "http://localhost:24661")
            //          .AllowAnyHeader()
            //           .AllowAnyMethod()
            //           .AllowCredentials();
            //    });
            //});

            // 讀取配置文件內容
            OptionConfigure(services);
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env, IOptions<CorsOptions> corsOptions)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseHsts();
            }

            // 容許全部跨域,cors是在ConfigureServices方法中配置的跨域策略名稱
            //app.UseCors("cors");

            // 設定特定ip容許跨域 CustomCorsPolicy是在ConfigureServices方法中配置的跨域策略名稱
            //app.UseCors("CustomCorsPolicy");

            // 設置容許全部來源跨域
            //app.UseCors(options =>
            //{
            //    options.AllowAnyHeader();
            //    options.AllowAnyMethod();
            //    options.AllowAnyOrigin();
            //    options.AllowCredentials();
            //});

            // 設置只容許特定來源能夠跨域
            //app.UseCors(options =>
            //{
            //    options.WithOrigins("http://localhost:3000", "http://127.0.0.1"); // 容許特定ip跨域
            //    options.AllowAnyHeader();
            //    options.AllowAnyMethod();
            //    options.AllowCredentials();
            //});

            // 利用配置文件實現
            CorsOptions _corsOption = corsOptions.Value;
            // 分割成字符串數組
            string[] hosts = _corsOption.url.Split('|');

            // 設置跨域
            app.UseCors(options =>
            {
                options.WithOrigins(hosts);
                options.AllowAnyHeader();
                options.AllowAnyMethod();
                options.AllowCredentials();
            });

            app.UseHttpsRedirection();
            app.UseMvc();
        }

        private void OptionConfigure(IServiceCollection services)
        {
            services.Configure<CorsOptions>(Configuration.GetSection("AllowedHosts"));
        }
    }
}

 

這樣就能夠實現利用配置文件實現容許跨域了。

相關文章
相關標籤/搜索