AntDesign Pro + .NET Core 實現基於JWT的登錄認證功能

Posted on 2021-03-06 by WalkonNet

很多同學說AgileConfig的UI實在是太醜瞭。我想想也是的，本來這個項目是我自己使用的，一開始甚至連UI都沒有，全靠手動在數據庫裡修改數據。後來加上瞭UI也是使用瞭老掉牙的bootstrap3做為基礎樣式。前臺框架也是使用瞭angularjs，同樣是老掉牙的東西。過年期間終於下決心翻新AgileConfig的前端UI。最後選擇的前端UI框架為AntDesign Pro + React。至於為啥選Ant-Design Pro是因為他好看，而且流行，選擇React是因為VUE跟Angular我都略知一二，幹脆趁此機會學一學React為何物，為何這麼流行。
登錄的認證方案為JWT，其實本人對JWT不太感冒（請看這裡《我們真的需要jwt嗎？》），無奈大傢都喜歡，那我也隻能隨大流。
其實基於ant-design pro的界面我已經翻的差不多瞭，因為它支持mock數據，所以我一行後臺代碼都沒修改，已經把界面快寫完瞭。從現在開始要真正的跟後端代碼進行聯調瞭。那麼我們先從登錄開始吧。先看看後端asp.net core方面會如何進行修改。

修改ASP.NET Core後端代碼

 "JwtSetting": {
 "SecurityKey": "xxxxxxxxxxxx", // 密鑰
 "Issuer": "agileconfig.admin", // 頒發者
 "Audience": "agileconfig.admin", // 接收者
 "ExpireSeconds": 20 // 過期時間 s
 }

在appsettings.json文件添加jwt相關配置。

 public class JwtSetting
 {
  static JwtSetting()
  {
   Instance = new JwtSetting();
   Instance.Audience = Global.Config["JwtSetting:Audience"];
   Instance.SecurityKey = Global.Config["JwtSetting:SecurityKey"];
   Instance.Issuer = Global.Config["JwtSetting:Issuer"];
   Instance.ExpireSeconds = int.Parse(Global.Config["JwtSetting:ExpireSeconds"]);
  }

  public string SecurityKey { get; set; }

  public string Issuer { get; set; }

  public string Audience { get; set; }

  public int ExpireSeconds { get; set; }

  public static JwtSetting Instance
  {
   get;
  }
 }

定義一個JwtSetting類，用來讀取配置。

 public void ConfigureServices(IServiceCollection services)
  {
   services.AddMemoryCache();
   services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
      .AddJwtBearer(options =>
      {
       options.TokenValidationParameters = new TokenValidationParameters
       {
        ValidIssuer = JwtSetting.Instance.Issuer,
        ValidAudience = JwtSetting.Instance.Audience,
        IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(JwtSetting.Instance.SecurityKey)),
       };
      });
   services.AddCors();
   services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_3_0).AddRazorRuntimeCompilation();
   services.AddFreeSqlDbContext();
   services.AddBusinessServices();
   services.AddAntiforgery(o => o.SuppressXFrameOptionsHeader = true);
  }

修改Startup文件的ConfigureServices方法，修改認證Scheme為JwtBearerDefaults.AuthenticationScheme，在AddJwtBearer方法內配置jwt相關配置信息。因為前後端分離項目所以有可能api跟ui部署在不同的域名下，所以開啟Cors。

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
  public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IServiceProvider serviceProvider)
  {
   if (env.IsDevelopment())
   {
    app.UseDeveloperExceptionPage();
   }
   else
   {
    app.UseMiddleware<ExceptionHandlerMiddleware>();
   }
   app.UseCors(op=> {
    op.AllowAnyOrigin();
    op.AllowAnyMethod();
    op.AllowAnyHeader();
   });
   app.UseWebSockets(new WebSocketOptions()
   {
    KeepAliveInterval = TimeSpan.FromSeconds(60),
    ReceiveBufferSize = 2 * 1024
   });
   app.UseMiddleware<WebsocketHandlerMiddleware>();
   app.UseStaticFiles();
   app.UseRouting();
   app.UseAuthentication();
   app.UseAuthorization();
   app.UseEndpoints(endpoints =>
   {
    endpoints.MapDefaultControllerRoute();
   });
  }

修改Startup的Configure方法，配置Cors為Any。

 public class JWT
 {
  public static string GetToken()
  {
   //創建用戶身份標識，可按需要添加更多信息
   var claims = new Claim[]
   {
 new Claim(JwtRegisteredClaimNames.Jti, Guid.NewGuid().ToString()),
 new Claim("id", "admin", ClaimValueTypes.String), // 用戶id
 new Claim("name", "admin"), // 用戶名
 new Claim("admin", true.ToString() ,ClaimValueTypes.Boolean) // 是否是管理員
   };
   var key = Encoding.UTF8.GetBytes(JwtSetting.Instance.SecurityKey);
   //創建令牌
   var token = new JwtSecurityToken(
    issuer: JwtSetting.Instance.Issuer,
    audience: JwtSetting.Instance.Audience,
    signingCredentials: new SigningCredentials(new SymmetricSecurityKey(key), SecurityAlgorithms.HmacSha256Signature),
    claims: claims,
    notBefore: DateTime.Now,
    expires: DateTime.Now.AddSeconds(JwtSetting.Instance.ExpireSeconds)
   );

   string jwtToken = new JwtSecurityTokenHandler().WriteToken(token);

   return jwtToken;
  }
 }

添加一個JWT靜態類用來生成jwt的token。因為agileconfig的用戶隻有admin一個所以這裡用戶名，ID都直接寫死。

[HttpPost("admin/jwt/login")]
  public async Task<IActionResult> Login4AntdPro([FromBody] LoginVM model)
  {
   string password = model.password;
   if (string.IsNullOrEmpty(password))
   {
    return Json(new
    {
     status = "error",
     message = "密碼不能為空"
    });
   }

   var result = await _settingService.ValidateAdminPassword(password);
   if (result)
   {

    var jwt = JWT.GetToken();

    return Json(new { 
     status="ok",
     token=jwt,
     type= "Bearer",
     currentAuthority = "admin"
    });
   }

   return Json(new
   {
    status = "error",
    message = "密碼錯誤"
   });
  }

新增一個Action方法做為登錄的入口。在這裡驗證完密碼後生成token，並且返回到前端。
到這裡.net core這邊後端代碼改動的差不多瞭。主要是添加jwt相關的東西，這些內容網上已經寫瞭很多瞭，不在贅述。
下面開始修改前端代碼。

修改AntDesign Pro的代碼

AntDesign Pro已經為我們生成好瞭登錄頁面，登錄的邏輯等，但是原來的登錄是假的，也不支持jwt token做為登錄憑證，下面我們要修改多個文件來完善這個登錄。

export function setToken(token:string): void {
 localStorage.setItem('token', token);
}

export function getToken(): string {
 var tk = localStorage.getItem('token');
 if (tk) {
 return tk as string;
 }

 return '';
}

在utils/authority.ts文件內新增2個方法，用來存儲跟獲取token。我們的jwt token存儲在localStorage裡。

/** 配置request請求時的默認參數 */
const request = extend({
 prefix: 'http://localhost:5000',
 errorHandler, // 默認錯誤處理
 credentials: 'same-origin', // 默認請求是否帶上cookie,
});
const authHeaderInterceptor = (url: string, options: RequestOptionsInit) => {
 const authHeader = { Authorization: 'Bearer ' + getToken() };
 return {
 url: `${url}`,
 options: { ...options, interceptors: true, headers: authHeader },
 };
};

request.interceptors.request.use(authHeaderInterceptor);

修改utils/request.ts文件，定義一個添加Authorization頭部的攔截器，並且使用這個攔截器，這有每次請求的時候自動會帶上這個頭部，把jwt token傳送到後臺。
設置prefix為http://localhost:5000這是我們的後端api的服務地址，真正生產的時候會替換為正式地址。
設置credentials為same-origin。

export async function accountLogin(params: LoginParamsType) {
 return request('/admin/jwt/login', {
 method: 'POST',
 data: params,
 });
}

在services/login.ts文件內新增發起登錄請求的方法。

 effects: {
 *login({ payload }, { call, put }) {
  const response = yield call(accountLogin, payload);
  yield put({
  type: 'changeLoginStatus',
  payload: response,
  });
  // Login successfully
  if (response.status === 'ok') {
  const urlParams = new URL(window.location.href);
  const params = getPageQuery();
  message.success('🎉 🎉 🎉 登錄成功！');
  let { redirect } = params as { redirect: string };
  if (redirect) {
   console.log('redirect url ' , redirect);
   const redirectUrlParams = new URL(redirect);
   if (redirectUrlParams.origin === urlParams.origin) {
   redirect = redirect.substr(urlParams.origin.length);
   if (redirect.match(/^\/.*#/)) {
    redirect = redirect.substr(redirect.indexOf('#') + 1);
   }
   } else {
   window.location.href = '/';
   return;
   }
  }
  history.replace(redirect || '/');
  }
 },


  reducers: {
 changeLoginStatus(state, { payload }) {
  setAuthority(payload.currentAuthority);
  setToken(payload.token)
  return {
  ...state,
  status: payload.status,
  type: payload.type,
  };
 },
 },

修改models/login.ts文件，修改effects的login方法，在內部替換原來的fakeAccountLogin為accountLogin。同時修改reducers內部的changeLoginStatus方法，添加setToken的代碼，這有修改後登錄成功後token就會被存儲起來。

 effects: {
 *fetch(_, { call, put }) {
  const response = yield call(queryUsers);
  yield put({
  type: 'save',
  payload: response,
  });
 },
 *fetchCurrent(_, { call, put }) {
  const response = {
  name: '管理員',
  userid: 'admin'
  };
  yield put({
  type: 'saveCurrentUser',
  payload: response,
  });
 },
 },

修改models/user.ts文件，修改effects的fetchCurrent方法為直接返回response。本來fetchCurrent是會去後臺拉當前用戶信息的，因為agileconfig的用戶就admin一個，所以我直接寫死瞭。

讓我們試一下登錄吧：）
源碼在這：https://github.com/kklldog/AgileConfig/tree/react_ui 🌟🌟🌟

到此這篇關於AntDesign Pro + .NET Core 實現基於JWT的登錄認證的文章就介紹到這瞭,更多相關.NET Core 登錄認證內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

AntDesign Pro + .NET Core 實現基於JWT的登錄認證功能

修改AntDesign Pro的代碼

推薦閱讀：

發佈留言取消回覆

近期文章

修改AntDesign Pro的代碼

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆