mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-05 17:38:03 +08:00
224 lines
9.8 KiB
HTML
224 lines
9.8 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Entity Framework Core integration </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Entity Framework Core integration ">
|
|
<meta name="generator" content="docfx 2.56.7.0">
|
|
|
|
<link rel="shortcut icon" href="../images/favicon.ico">
|
|
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/night-owl.min.css">
|
|
<link rel="stylesheet" href="../styles/colors.css">
|
|
<link rel="stylesheet" href="../styles/discord.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div class="top-navbar">
|
|
|
|
<a href="javascript:void(0);" class="burger-icon" onclick="toggleMenu()">
|
|
<svg name="Hamburger" style="vertical-align: middle;" width="24" height="24" viewbox="0 0 24 24"><path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M20 6H4V9H20V6ZM4 10.999H20V13.999H4V10.999ZM4 15.999H20V18.999H4V15.999Z"></path></svg>
|
|
</a>
|
|
|
|
|
|
<a class="brand" href="../index.html">
|
|
<img src="../images/logo.png" alt="OpenIddict" class="logomark">
|
|
<span class="brand-title">OpenIddict</span>
|
|
</a>
|
|
</div>
|
|
|
|
<div class="body-content">
|
|
|
|
<div id="blackout" class="blackout" onclick="toggleMenu()"></div>
|
|
|
|
<nav id="sidebar" role="navigation">
|
|
|
|
<div class="sidebar">
|
|
|
|
|
|
|
|
|
|
<div>
|
|
|
|
<a class="brand" href="../index.html">
|
|
<img src="../images/logo.png" alt="OpenIddict" class="logomark">
|
|
<span class="brand-title">OpenIddict</span>
|
|
</a>
|
|
<div id="navbar">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="sidebar-item-separator"></div>
|
|
|
|
|
|
<div id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="footer">
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</nav>
|
|
|
|
<main class="main-panel">
|
|
|
|
<div role="main" class="hide-when-search">
|
|
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<article class="content wrap" id="_content" data-uid="">
|
|
<h1 id="entity-framework-core-integration">Entity Framework Core integration</h1>
|
|
|
|
<h2 id="basic-configuration">Basic configuration</h2>
|
|
<p>To configure OpenIddict to use Entity Framework Core as the database for applications, authorizations, scopes and tokens, you'll need to:</p>
|
|
<ul>
|
|
<li><p><strong>Reference the <code>OpenIddict.EntityFrameworkCore</code> package</strong>:</p>
|
|
<pre><code class="lang-xml"><PackageReference Include="OpenIddict.EntityFrameworkCore" Version="3.1.1" />
|
|
</code></pre></li>
|
|
<li><p><strong>Create a database context deriving from <code>DbContext</code> (or <code>IdentityDbContext</code> when using ASP.NET Core Identity)</strong>:</p>
|
|
<pre><code class="lang-csharp">public class ApplicationDbContext : DbContext
|
|
{
|
|
public ApplicationDbContext(DbContextOptions options)
|
|
: base(options)
|
|
{
|
|
}
|
|
}
|
|
</code></pre></li>
|
|
<li><p><strong>Configure OpenIddict to use the Entity Framework Core stores</strong>:</p>
|
|
<pre><code class="lang-csharp">services.AddOpenIddict()
|
|
.AddCore(options =>
|
|
{
|
|
options.UseEntityFrameworkCore()
|
|
.UseDbContext<ApplicationDbContext>();
|
|
});
|
|
</code></pre></li>
|
|
<li><p><strong>Configure Entity Framework Core to register the OpenIddict entities in the model</strong>:</p>
|
|
<pre><code class="lang-csharp">services.AddDbContext<ApplicationDbContext>(options =>
|
|
{
|
|
// Configure the Entity Framework Core to use Microsoft SQL Server.
|
|
options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"));
|
|
|
|
// Register the entity sets needed by OpenIddict.
|
|
options.UseOpenIddict();
|
|
});
|
|
</code></pre></li>
|
|
<li><p><strong>Use migrations or recreate the database to add the OpenIddict entities</strong>.
|
|
For more information, read <a href="https://docs.microsoft.com/en-us/ef/core/managing-schemas/migrations/">Migrations Overview</a>.</p>
|
|
</li>
|
|
</ul>
|
|
<h2 id="advanced-configuration">Advanced configuration</h2>
|
|
<h3 id="use-a-custom-primary-key-type">Use a custom primary key type</h3>
|
|
<p>By default, the Entity Framework Core integration uses <code>string</code> primary keys, which matches the default key type used by ASP.NET Core Identity.</p>
|
|
<p>To use a different key type (e.g <code>int</code>, <code>long</code> or <code>Guid</code>):</p>
|
|
<ul>
|
|
<li><p><strong>Call the generic <code>ReplaceDefaultEntities<TKey>()</code> method to force OpenIddict to use the default entities with the specified key type</strong>:</p>
|
|
<pre><code class="lang-csharp">services.AddOpenIddict()
|
|
.AddCore(options =>
|
|
{
|
|
// Configure OpenIddict to use the default entities with a custom key type.
|
|
options.UseEntityFrameworkCore()
|
|
.UseDbContext<ApplicationDbContext>()
|
|
.ReplaceDefaultEntities<Guid>();
|
|
});
|
|
</code></pre></li>
|
|
<li><p><strong>Configure Entity Framework Core to include the default entities with the chosen key type in the model</strong>:</p>
|
|
<pre><code class="lang-csharp">services.AddDbContext<ApplicationDbContext>(options =>
|
|
{
|
|
// Configure Entity Framework Core to use Microsoft SQL Server.
|
|
options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"));
|
|
|
|
// Register the entity sets needed by OpenIddict but use a custom key type.
|
|
options.UseOpenIddict<Guid>();
|
|
});
|
|
</code></pre></li>
|
|
</ul>
|
|
<h3 id="use-custom-entities">Use custom entities</h3>
|
|
<p>For applications that require storing additional data alongside the properties used by OpenIddict, custom entities can be used. For that, you need to:</p>
|
|
<ul>
|
|
<li><p><strong>Create custom entities</strong>:</p>
|
|
<pre><code class="lang-csharp">public class CustomApplication : OpenIddictEntityFrameworkCoreApplication<long, CustomAuthorization, CustomToken>
|
|
{
|
|
public string CustomProperty { get; set; }
|
|
}
|
|
|
|
public class CustomAuthorization : OpenIddictEntityFrameworkCoreAuthorization<long, CustomApplication, CustomToken>
|
|
{
|
|
public string CustomProperty { get; set; }
|
|
}
|
|
|
|
public class CustomScope : OpenIddictEntityFrameworkCoreScope<long>
|
|
{
|
|
public string CustomProperty { get; set; }
|
|
}
|
|
|
|
public class CustomToken : OpenIddictEntityFrameworkCoreToken<long, CustomApplication, CustomAuthorization>
|
|
{
|
|
public string CustomProperty { get; set; }
|
|
}
|
|
</code></pre></li>
|
|
<li><p><strong>Call the generic <code>ReplaceDefaultEntities<TApplication, TAuthorization, TScope, TToken, TKey>()</code> method to force OpenIddict to use the custom entities</strong>:</p>
|
|
<pre><code class="lang-csharp">services.AddOpenIddict()
|
|
.AddCore(options =>
|
|
{
|
|
// Configure OpenIddict to use the custom entities.
|
|
options.UseEntityFrameworkCore()
|
|
.UseDbContext<ApplicationDbContext>()
|
|
.ReplaceDefaultEntities<CustomApplication, CustomAuthorization, CustomScope, CustomToken, long>();
|
|
});
|
|
</code></pre></li>
|
|
<li><p><strong>Configure Entity Framework Core to include the custom entities in the model</strong>:</p>
|
|
<pre><code class="lang-csharp">services.AddDbContext<ApplicationDbContext>(options =>
|
|
{
|
|
// Configure Entity Framework Core to use Microsoft SQL Server.
|
|
options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"));
|
|
|
|
// Register the entity sets needed by OpenIddict but use the specified entities instead of the default ones.
|
|
options.UseOpenIddict<CustomApplication, CustomAuthorization, CustomScope, CustomToken, long>();
|
|
});
|
|
</code></pre></li>
|
|
</ul>
|
|
</article>
|
|
|
|
</div>
|
|
</main>
|
|
</div>
|
|
|
|
|
|
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
|
|
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></script>
|
|
<script type="text/javascript" src="../styles/jquery.twbsPagination.js"></script>
|
|
<script type="text/javascript" src="../styles/url.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/anchor-js/anchor.min.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
|
|
</body>
|
|
|
|
</html>
|