ASP.NET Core优雅的在开发环境保存机密（User Secrets）

2024-09-29 01:02:35

前言

在应用程序开发的过程中，有的时候需要在代码中保存一些机密的信息，比如加密密钥，字符串，或者是用户名密码等。通常的做法是保存到一个配置文件中，在以前我们会把他保存到web.config中，但是在ASP.NET Core中，这一方式或许发生了改变，或者说你有更多多元化的方法, 以及更加优雅的的配置来设置或者保存这些机密资料。

起初我以为这个UserSecrets它并没有什么用，因为我有需要配置的地方我直接配置到appsetting.json文件中就可以了，直到一次开发过程中，我才感受到了它真正的用途。

用户机密介绍
如何添加用户机密
在应用程序中使用用户机密
总结

用户机密介绍

有以下场景大家可以想一下在以前的代码中我们是怎么样处理的：

需要保存一些和第三方网站对接的密钥，比如和微信，微博站点使用的 appkey
给每个开发人员配置不用的用户名密码来访问一些资源
开发人员在开发过程中使用各自本机的数据库，如何配置数据库地址、账号和密码

假设说最后一项，每个开发要使用自己本机的数据库，你可能会说让每个人修改自己的web.config，在提交代码的时候不提交就行了。那么如果在web.config添加其他配置项的时候，显然不提交web.config文件不合理的。

现在，ASP.NET Core 提供了一种很优雅简洁的方式 User Secrets 用来帮助我们解决这个事情。

在新建一个 ASP.NET Core Web 应用程序的时候，会在 Startup.cs 文件中看到这样一段代码：

public Startup(IHostingEnvironment env)
{
  .....

  if (env.IsDevelopment())
  {
    builder.AddUserSecrets();
  }

  builder.AddEnvironmentVariables();
}

在 project.json 文件中，会看到 User Secrets 相关的一些配置

{
  "userSecretsId": "aspnet-WebAppCore-e278c40f-15bd-4c19-9662-541514f02f3e"
  ...

  "Microsoft.Extensions.Configuration.UserSecrets": "1.0.0",
  "Microsoft.Extensions.SecretManager.Tools": “1.0.0-preview2-final”
}

可以看到builder.AddUserSecrets这行代码，他是在开发环境才运行的。

userSecretsId是用来标识项目的User Secrets唯一性的，如果有两个项目需要使用不同的Secrets ，这就需要有不同的userSecretsId。

Microsoft.Extensions.SecretManager.Tools 主要是用来设置或者查看secrets的值。

如何添加用户机密

可以在命令行中使用命令来添加：

image

切换命令行窗口到程序的运行目录，输入 dotnet user-secrets -h ,来查看可以使用的命令
使用 dotnet user-secrets list 列出所有的用户机密
使用 dotnet user-secrets set WeChatAppKey "X3423FEED2435DD"设置一个用户机密，其中 WebChatAppKey 为键，后面的是值。
然后使用dotnet user-secrets list来查看设置的键值对。
然后我又设置了一个数据库的连接字符串进去。

以上是使用命令行的方式来设置用户机密，也可以使用 Visual Studio 2015代替命令行来做这项工作。

Visual Studio中，在Web项目上右键,可以看到一个 管理用户机密 的菜单：

image

点击打开时候，会出现一个secrets.json的文件，里面就是刚刚在命令行设置的键值对：

image

有些同学可能会问既然是存储到secrets.json，那么这个文件是在哪里呢？

secrets.json的存储位置？

在非Windows系统中，它的存储位置在

~/.microsoft/usersecrets/<userSecretsId>/secrets.json

在Windows系统中，它的位置在

C:\Users\用户名\AppData\Roaming\Microsoft\UserSecrets\aspnet-WebAppCore-e278c40f-15bd-4c19-9662-541514f02f3e

可以看到，存储的上层文件夹就是project.json文件中的 userSecretsId 设定的值。

在应用程序中使用用户机密

要在应用程序中访问配置的用户机密，你需要保证project.json文件中存在依赖项：
Microsoft.Extensions.Configuration.UserSecrets 并且builder.AddUserSecrets()。

然后在Startup.cs文件中通过 Configuration 对象访问

public IConfigurationRoot Configuration { get; }
public void ConfigureServices(IServiceCollection services)
{
  var wechatKey = Configuration["WeChatAppKey"]
}

你可以使用DI来将用户机密映射到一个C#类文件，像这样

secrets.json

{
  "SecretsKeys":
  {
    WeCharAppKey:"xxejfwert3045",
    WeboAppKey:"35402345lkefgjlkdfg",
    .....
  }
}

SecretsKeysConfig.cs

public class SecretsKeysConfig
{
  public string WeCharAppKey { get; set;}

  public string WeboAppKey { get; set;}

  // ......
}

Startup.cs

public void ConfigureServices(IServiceCollection services)
{
  services.Configure<SecretsKeysConfig>(Configuration.GetSection("SecretsKeys"));

  // 其他代码
}

HomeController.cs

public class HomeController : Controller
{
  public SecretsKeysConfig AppConfigs { get; }
  public HomeController(IOptions<SecretsKeysConfig> appkeys)
  {
    AppConfigs = appkeys.Value;
  }

}

注意：如果你的appsetting.json文件中有和secrets.json文件中相同节点（冲突）的配置项，那么就会被secrets.json中的设置项给覆盖掉，因为 builder.AddUserSecrets()晚于 AddJsonFile("appsettings.json")注册, 那么我们可以利用这个特性来在每个开发人员的机器上重新设置数据库连接字符串了。

总结

以上，或许可以感受到微软在 ASP.NET Core 中对于开发人员还是非常贴心的，很多小细节都考虑到了，因此在我们构建应用程序的过程中，可以多使用这些小功能（特性）来让我们的代码更加的优雅～

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。

win10下ASP.NET Core部署环境搭建步骤

随着ASP.NET Core 1.0 rtm的发布,网上有许多相关.net core 相关文章,今刚好有时间也在win10环境上搭建下 ASP.NET Core的部署环境,把过程记录下给大家. 1. 开发运行环境 1> Visual Studio 2015 Update 3* 2> .NET Core 1.0 for Visual Studio (包括asp.net core 模板,其中如果机器上没有.net core sdk会默认安装)地址https://go.microsoft.com/f
云服务器下搭建ASP.NET Core环境

最近.net core如火如荼,国内这方面环境搭建方面的文档也非常多,但是不少已经是过时的,就算按照那个流程走下去也避免不了一些地方早就不一样了.所以下面我将从头到尾的教大家搭建一次环境,并且成功运行官网的demo. 一.系统环境本次笔者因为懒的去做虚拟机,所以注册了一个云提供商的试用账户作为本次的主机. 系统: Ubuntu Server 14.04.2 LTS 64bit Mono: 1.0.0-rc1-update1 Coreclr: 1.0.0-rc1-update1 二.正文 1.首
Windows Server 2012 R2 Standard搭建ASP.NET Core环境图文教程

前言: 随着ASP.NET Core 1.0的发布,论坛里相关的文章也越来越多,正好有时间在测试环境上搭建 ASP.NET Core的发布环境,把过程中遇到的问题写给大家,以便有用到的朋友需要. 环境: Windows Server 2012 R2 Standard with Update MSDN 链接:ed2k://|file|cn_windows_server_2012_r2_with_update_x64_dvd_6052725.iso|5545705472|121EC13B53882E
ASP.NET Core程序发布到Linux生产环境详解

在这篇文章里我们将介绍如何在 Ubuntu 14.04 Server上部署ASP.NET Core应用程序.我们将把ASP.NET Core应用程序放到一个反向代理服务器的后面,由代理服务器把请求转交给我们的Kestrel服务器.除此之外,我们还将保证我们的web应用程序作为一个守护进程来进行启动.我们需要配置一个进程管理工具来帮助我们在程序崩溃时恢复程序,以保证高可用性. 章节: 准备复制你的应用程序配置一个反向代理服务器监控我们的应用程序启动我们的应用程序观察日志使我们的应用程序
Linux(Ubuntu)下搭建ASP.NET Core环境

今天来学习一下ASP.NET Core 运行在Ubuntu中.无需安装mono . 环境 Ubuntu 14.04.4 LTS 服务器版全新安装系统. 下载地址:http://mirrors.neusoft.edu.cn/ubuntu-releases/14.04.4/ubuntu-14.04.4-server-amd64.iso 你也可以下载桌面版安装. 下载地址:http://mirrors.neusoft.edu.cn/ubuntu-releases/14.04.4/ 安装DNVM 首先
VS2015 搭建Asp.net core开发环境的方法

前言随着ASP.NET Core 1.0 rtm的发布,网上有许多相关.net core 相关文章,最近正好有时间就尝试VS2015 搭建Asp.net core开发环境,以下是简单的搭建过程,下面来一起看看吧. 步骤如下一.首先你得装个vs2015 并且保证已经升级至 update3及以上(此处附上一个vs2015带up3的下载链接: ed2k://|file|cn_visual_studio_enterprise_2015_with_update_3_x86_x64_dvd_892329
ASP.NET Core环境设置教程（2）

Asp.Net Core是Asp.Net的一个重大的重新设计. 这个话题介绍了ASP.NET Core的新的概念,并解释它们如何帮助您开发现代的web应用程序. 使用ASP.NET Core开发应用程序,以下必须安装在你的系统: Microsoft Visual Studio 2015 Microsoft .NET Core 1.0.0 - VS 2015 Tooling Preview 2 微软提供了一个免费版本的Visual Studio,它里面还包含了SQL Server,它可以从www.
ubuntu16.4下用jexus部署ASP.NET Core环境

上篇文章介绍了下用vs发布部署到iis环境,今天说下ubuntu下部署asp.net core,不需要安装.net core sdk,自带运行时方式部署,利用jexus服务器转发请求到asp.net core. 1.部署准备环境 vmware虚拟机(其他也可以) ubuntu16.04镜像 2.发布环境 win10系统 vs2015 update3 或vs code (也可以用dotnet new -t web 命令创建项目) dotnet sdk DotNetCore.1.0.0-SDK.Pr
详解将ASP.NET Core应用程序部署至生产环境中（CentOS7）

将ASP.NET Core应用程序部署至生产环境中(CentOS7) 阅读目录环境说明准备你的ASP.NET Core应用程序安装CentOS7 安装.NET Core SDK for CentOS7. 部署ASP.NET Core应用程序配置Nginx 配置守护服务(Supervisor) 这段时间在使用Rabbit RPC重构公司的一套系统(微信相关),而最近相关检验(逻辑测试.压力测试)已经完成,接近部署至线上生产环境从而捣鼓了ASP.NET Core应用程序在CentOS上的部署
ASP.NET Core优雅的在开发环境保存机密（User Secrets）

前言在应用程序开发的过程中,有的时候需要在代码中保存一些机密的信息,比如加密密钥,字符串,或者是用户名密码等.通常的做法是保存到一个配置文件中,在以前我们会把他保存到web.config中,但是在ASP.NET Core中,这一方式或许发生了改变,或者说你有更多多元化的方法, 以及更加优雅的的配置来设置或者保存这些机密资料. 起初我以为这个UserSecrets它并没有什么用,因为我有需要配置的地方我直接配置到appsetting.json文件中就可以了,直到一次开发过程中,我才感受到了它真正
发布asp.net core时如何修改ASPNETCORE_ENVIRONMENT环境变量

遇到的问题当我把 asp.net core web 发布到本地文件时,我发现程序读的是 appsettings.Production.json ,也就说明当前的 ASPNETCORE_ENVIRONMENT = Production. 请问如何动态修改 ASPNETCORE_ENVIRONMENT的值,这样的话在调试和发布阶段都非常灵活了,但我尝试在下面几个地方修改都没有成功... windows settings .pubxml file launchSettings.json pr
ASP.Net Core MVC基础系列之环境设置

上一节我们介绍了中间件的基本使用, 这一节我们讲一讲.Net Core的环境设置, 以及根据不同的环境加载不同的配置信息 PS: 由于最近一直比较忙, 一直没抽时间更新这个系列, 最近居多的博友催我, 所以继续挤挤时间更新这个系列, 感谢大家的对本系列教程的喜欢和支持. 在实际开发中, 我们的系统往往会是至少两个以上的运行环境, 最基本的就是, 开发环境和运营环境, 体系完整的公司, 还会有测试环境, 预发布环境, 和一些自定义环境等等, 这些环境使用的配置或是一些参数肯定是不一样的, 我们不可
.Net Core+Angular Cli/Angular4开发环境搭建教程

一.基础环境配置 1.安装VS 2017 v15.3或以上版本 2.安装VS Code最新版本 3.安装Node.js v6.9以上版本 4.重置全局npm源,修正为淘宝的 NPM 镜像: npm install -g cnpm --registry=https://registry.npm.taobao.org 5.安装TypeScript cnpm install -g typescript typings 6.安装 AngularJS CLI cnpm install -g @angul
ASP.NET Core开发环境安装配置

ASP.NET Core环境设置 1.如何设置用于.NetCore应用程序开发的开发机器 2.安装SDK和IDE 3.验证安装开发和.NET Core应用程序所需的工具和软件 1.设备:(Windows.Mac.Linux) 2.IDE:Visual Studio.Visual Code 3.NetSDK:软件开发工具包,此工具包有助于开发和运行系统中的应用程序. 如何为构建 .NET Core/ASP.NET Core应用程序准备开发环境? NET Core可以通过两种方式安装: 1.通过安
ASP.NET Core环境变量和启动设置的配置教程

在这一部分内容中,我们来讨论ASP.NET Core中的一个新功能:环境变量和启动设置,它将开发过程中的调试和测试变的更加简单.我们只需要简单的修改配置文件,就可以实现开发.预演.生产环境的切换. ASPNETCORE_ENVIRONMENT ASP.NET Core控制环境切换最核心的东西是"ASPNETCORE_ENVIRONMENT"环境变量,它直接控制当前应用程序运行的环境类型.您可以通过在项目上右键菜单选择"属性"选项,然后切换到"调试"
ASP.NET Core环境变量配置和启动设置讲解

ASPNETCORE_ENVIRONMENT ASP.NET Core控制环境切换最核心的东西是“ASPNETCORE_ENVIRONMENT”环境变量,它直接控制当前应用程序运行的环境类型.您可以通过在项目上右键菜单选择“属性”选项,然后切换到“调试”标签来修改此环境变量. 此环境变量框架默认提供了三个值,当然您也可以定义其它的值: Development(开发) Staging(预演) Production(生产) 我们在Startup.cs文件中,可以使用相应的方法来控制应用程序的行为.以
ASP.NET Core中使用多环境

ASP.NET Core 支持在多个环境中管理应用程序,如开发(Development),预演(Staging)和生产(Production).环境变量用来指示应用程序正在运行的环境,允许应用程序适当地配置. 1.环境变量 ASP.NET Core 引用一个特定的环境变量 ASPNETCORE_ENVIRONMENT 来描述应用程序当前运行的环境.这个变量可以被设置任何值,但是有三个值被约定使用:Development(开发),Staging(预演)和Production(生产). 当前环境变量
ASP.NET Core环境变量和启动设置的配置教程

在这一部分内容中,我们来讨论ASP.NET Core中的一个新功能:环境变量和启动设置,它将开发过程中的调试和测试变的更加简单.我们只需要简单的修改配置文件,就可以实现开发.预演.生产环境的切换. ASPNETCORE_ENVIRONMENT ASP.NET Core控制环境切换最核心的东西是“ASPNETCORE_ENVIRONMENT”环境变量,它直接控制当前应用程序运行的环境类型.您可以通过在项目上右键菜单选择“属性”选项,然后切换到“调试”标签来修改此环境变量. 此环境变量框架默认提供了
ASP.NET Core Web API 教程Project Configuration

目录 1. 创建新项目 2. launchSettings.json 文件 3. Program.cs 和 Startup.cs 4. 扩展方法和 CORS 配置 5. IIS 配置 6. Startup 类中的其它代码 7. 基于环境的设置前言: 本系列文章主要参考了<Ultimate ASP.NET Core 3 Web API>一书,对原文进行了翻译,同时适当删减.修改了一部分内容. 对于某些概念和原理,原书和本文中都没有进行详细描述,如果一一详细介绍,内容就显得臃肿且混乱,我个人是先

ASP.NET Core优雅的在开发环境保存机密（User Secrets）

相关推荐

随机推荐