reitit/ring/data_driven_middleware.html
2018-09-22 18:37:19 +00:00

903 lines
26 KiB
HTML

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Data-driven Middleware · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="../gitbook/style.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-hints/plugin-hints.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="transforming_middleware_chain.html" />
<link rel="prev" href="dynamic_extensions.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Introduction</li>
<li class="chapter " data-level="1.1" data-path="../">
<a href="../">
Introduction
</a>
</li>
<li class="header">Basics</li>
<li class="chapter " data-level="2.1" data-path="../basics/route_syntax.html">
<a href="../basics/route_syntax.html">
Route Syntax
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../basics/router.html">
<a href="../basics/router.html">
Router
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../basics/path_based_routing.html">
<a href="../basics/path_based_routing.html">
Path-based Routing
</a>
</li>
<li class="chapter " data-level="2.4" data-path="../basics/name_based_routing.html">
<a href="../basics/name_based_routing.html">
Name-based Routing
</a>
</li>
<li class="chapter " data-level="2.5" data-path="../basics/route_data.html">
<a href="../basics/route_data.html">
Route Data
</a>
</li>
<li class="chapter " data-level="2.6" data-path="../basics/route_data_validation.html">
<a href="../basics/route_data_validation.html">
Route Data Validation
</a>
</li>
<li class="chapter " data-level="2.7" data-path="../basics/route_conflicts.html">
<a href="../basics/route_conflicts.html">
Route Conflicts
</a>
</li>
<li class="header">Coercion</li>
<li class="chapter " data-level="3.1" data-path="../coercion/coercion.html">
<a href="../coercion/coercion.html">
Coercion Explained
</a>
</li>
<li class="chapter " data-level="3.2" data-path="../coercion/schema_coercion.html">
<a href="../coercion/schema_coercion.html">
Plumatic Schema
</a>
</li>
<li class="chapter " data-level="3.3" data-path="../coercion/clojure_spec_coercion.html">
<a href="../coercion/clojure_spec_coercion.html">
Clojure.spec
</a>
</li>
<li class="chapter " data-level="3.4" data-path="../coercion/data_spec_coercion.html">
<a href="../coercion/data_spec_coercion.html">
Data-specs
</a>
</li>
<li class="header">Ring</li>
<li class="chapter " data-level="4.1" data-path="ring.html">
<a href="ring.html">
Ring-router
</a>
</li>
<li class="chapter " data-level="4.2" data-path="reverse_routing.html">
<a href="reverse_routing.html">
Reverse-routing
</a>
</li>
<li class="chapter " data-level="4.3" data-path="default_handler.html">
<a href="default_handler.html">
Default handler
</a>
</li>
<li class="chapter " data-level="4.4" data-path="static.html">
<a href="static.html">
Static Resources
</a>
</li>
<li class="chapter " data-level="4.5" data-path="dynamic_extensions.html">
<a href="dynamic_extensions.html">
Dynamic Extensions
</a>
</li>
<li class="chapter active" data-level="4.6" data-path="data_driven_middleware.html">
<a href="data_driven_middleware.html">
Data-driven Middleware
</a>
</li>
<li class="chapter " data-level="4.7" data-path="transforming_middleware_chain.html">
<a href="transforming_middleware_chain.html">
Transforming Middleware Chain
</a>
</li>
<li class="chapter " data-level="4.8" data-path="middleware_registry.html">
<a href="middleware_registry.html">
Middleware Registry
</a>
</li>
<li class="chapter " data-level="4.9" data-path="default_middleware.html">
<a href="default_middleware.html">
Default Middleware
</a>
</li>
<li class="chapter " data-level="4.10" data-path="coercion.html">
<a href="coercion.html">
Pluggable Coercion
</a>
</li>
<li class="chapter " data-level="4.11" data-path="route_data_validation.html">
<a href="route_data_validation.html">
Route Data Validation
</a>
</li>
<li class="chapter " data-level="4.12" data-path="compiling_middleware.html">
<a href="compiling_middleware.html">
Compiling Middleware
</a>
</li>
<li class="chapter " data-level="4.13" data-path="swagger.html">
<a href="swagger.html">
Swagger Support
</a>
</li>
<li class="header">HTTP</li>
<li class="chapter " data-level="5.1" data-path="../http/interceptors.html">
<a href="../http/interceptors.html">
Interceptors
</a>
</li>
<li class="chapter " data-level="5.2" data-path="../http/pedestal.html">
<a href="../http/pedestal.html">
Pedestal
</a>
</li>
<li class="chapter " data-level="5.3" data-path="../http/sieppari.html">
<a href="../http/sieppari.html">
Sieppari
</a>
</li>
<li class="chapter " data-level="5.4" data-path="../http/default_interceptors.html">
<a href="../http/default_interceptors.html">
Default Interceptors
</a>
</li>
<li class="header">Frontend</li>
<li class="chapter " data-level="6.1" data-path="../frontend/basics.html">
<a href="../frontend/basics.html">
Basics
</a>
</li>
<li class="chapter " data-level="6.2" data-path="../frontend/browser.html">
<a href="../frontend/browser.html">
Browser integration
</a>
</li>
<li class="chapter " data-level="6.3" data-path="../frontend/controllers.html">
<a href="../frontend/controllers.html">
Controllers
</a>
</li>
<li class="header">Advanced</li>
<li class="chapter " data-level="7.1" data-path="../advanced/configuring_routers.html">
<a href="../advanced/configuring_routers.html">
Configuring Routers
</a>
</li>
<li class="chapter " data-level="7.2" data-path="../advanced/composing_routers.html">
<a href="../advanced/composing_routers.html">
Composing Routers
</a>
</li>
<li class="chapter " data-level="7.3" data-path="../advanced/different_routers.html">
<a href="../advanced/different_routers.html">
Different Routers
</a>
</li>
<li class="chapter " data-level="7.4" data-path="../advanced/route_validation.html">
<a href="../advanced/route_validation.html">
Route Validation
</a>
</li>
<li class="chapter " data-level="7.5" data-path="../advanced/dev_workflow.html">
<a href="../advanced/dev_workflow.html">
Dev Workflow
</a>
</li>
<li class="chapter " data-level="7.6" data-path="../advanced/shared_routes.html">
<a href="../advanced/shared_routes.html">
Shared Routes
</a>
</li>
<li class="header">Misc</li>
<li class="chapter " data-level="8.1" data-path="../performance.html">
<a href="../performance.html">
Performance
</a>
</li>
<li class="chapter " data-level="8.2" data-path="../development.html">
<a href="../development.html">
Development Instructions
</a>
</li>
<li class="chapter " data-level="8.3" data-path="../faq.html">
<a href="../faq.html">
FAQ
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href=".." >Data-driven Middleware</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="data-driven-middleware">Data-driven Middleware</h1>
<p>Ring <a href="https://github.com/ring-clojure/ring/wiki/Concepts#middleware" target="_blank">defines middleware</a> as a function of type <code>handler &amp; args =&gt; request =&gt; response</code>. It&apos;s relatively easy to understand and enables good performance. Downside is that the middleware-chain is just a opaque function, making things like debugging and composition hard. It&apos;s too easy to apply the middleware in wrong order.</p>
<p>Reitit defines middleware as data:</p>
<ol>
<li>Middleware can be defined as first-class data entries</li>
<li>Middleware can be mounted as a <a href="https://github.com/duct-framework/duct/wiki/Configuration" target="_blank">duct-style</a> vector (of middleware)</li>
<li>Middleware can be optimized &amp; <a href="compiling_middleware.html">compiled</a> againt an endpoint</li>
<li>Middleware chain can be transformed by the router</li>
</ol>
<h2 id="middleware-as-data">Middleware as data</h2>
<p>All values in the <code>:middleware</code> vector in the route data are expanded into <code>reitit.middleware/Middleware</code> Records with using the <code>reitit.middleware/IntoMiddleware</code> Protocol. By default, functions, maps and <code>Middleware</code> records are allowed.</p>
<p>Records can have arbitrary keys, but the following keys have a special purpose:</p>
<table>
<thead>
<tr>
<th>key</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>:name</code></td>
<td>Name of the middleware as a qualified keyword</td>
</tr>
<tr>
<td><code>:spec</code></td>
<td><code>clojure.spec</code> definition for the route data, see <a href="route_data_validation.html">route data validation</a> (optional)</td>
</tr>
<tr>
<td><code>:wrap</code></td>
<td>The actual middleware function of <code>handler &amp; args =&gt; request =&gt; response</code></td>
</tr>
<tr>
<td><code>:compile</code></td>
<td>Middleware compilation function, see <a href="compiling_middleware.html">compiling middleware</a>.</td>
</tr>
</tbody>
</table>
<p>Middleware Records are accessible in their raw form in the compiled route results, thus available for inventories, creating api-docs etc.</p>
<p>For the actual request processing, the Records are unwrapped into normal functions and composed into a middleware function chain, yielding zero runtime penalty.</p>
<h3 id="creating-middleware">Creating Middleware</h3>
<p>The following produce identical middleware runtime function.</p>
<h3 id="function">Function</h3>
<pre><code class="lang-clj">(<span class="hljs-name"><span class="hljs-builtin-name">defn</span></span> wrap [handler id]
(<span class="hljs-name"><span class="hljs-builtin-name">fn</span></span> [request]
(<span class="hljs-name">handler</span> (<span class="hljs-name">update</span> request <span class="hljs-symbol">::acc</span> (<span class="hljs-name">fnil</span> conj []) id))))
</code></pre>
<h3 id="map">Map</h3>
<pre><code class="lang-clj">(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> wrap3
{<span class="hljs-symbol">:name</span> <span class="hljs-symbol">::wrap3</span>
<span class="hljs-symbol">:description</span> <span class="hljs-string">&quot;Middleware that does things.&quot;</span>
<span class="hljs-symbol">:wrap</span> wrap})
</code></pre>
<h3 id="record">Record</h3>
<pre><code class="lang-clj">(<span class="hljs-name">require</span> &apos;[reitit.middleware <span class="hljs-symbol">:as</span> middleware])
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> wrap2
(<span class="hljs-name">middleware/create</span>
{<span class="hljs-symbol">:name</span> <span class="hljs-symbol">::wrap2</span>
<span class="hljs-symbol">:description</span> <span class="hljs-string">&quot;Middleware that does things.&quot;</span>
<span class="hljs-symbol">:wrap</span> wrap}))
</code></pre>
<h2 id="using-middleware">Using Middleware</h2>
<p><code>:middleware</code> is merged to endpoints by the <code>router</code>.</p>
<pre><code class="lang-clj">(<span class="hljs-name">require</span> &apos;[reitit.ring <span class="hljs-symbol">:as</span> ring])
(<span class="hljs-name"><span class="hljs-builtin-name">defn</span></span> handler [{<span class="hljs-symbol">:keys</span> [<span class="hljs-symbol">::acc</span>]}]
{<span class="hljs-symbol">:status</span> <span class="hljs-number">200</span>, <span class="hljs-symbol">:body</span> (<span class="hljs-name"><span class="hljs-builtin-name">conj</span></span> acc <span class="hljs-symbol">:handler</span>)})
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> app
(<span class="hljs-name">ring/ring-handler</span>
(<span class="hljs-name">ring/router</span>
[<span class="hljs-string">&quot;/api&quot;</span> {<span class="hljs-symbol">:middleware</span> [[wrap <span class="hljs-number">1</span>] [wrap2 <span class="hljs-number">2</span>]]}
[<span class="hljs-string">&quot;/ping&quot;</span> {<span class="hljs-symbol">:get</span> {<span class="hljs-symbol">:middleware</span> [[wrap3 <span class="hljs-number">3</span>]]
<span class="hljs-symbol">:handler</span> handler}}]])))
</code></pre>
<p>All the middleware are applied correctly:</p>
<pre><code class="lang-clj">(<span class="hljs-name">app</span> {<span class="hljs-symbol">:request-method</span> <span class="hljs-symbol">:get</span>, <span class="hljs-symbol">:uri</span> <span class="hljs-string">&quot;/api/ping&quot;</span>})
<span class="hljs-comment">; {:status 200, :body [1 2 3 :handler]}</span>
</code></pre>
<h2 id="compiling-middleware">Compiling middleware</h2>
<p>Middleware can be optimized against an endpoint using <a href="compiling_middleware.html">middleware compilation</a>.</p>
<h2 id="ideas-for-the-future">Ideas for the future</h2>
<ul>
<li>Support Middleware dependency resolution with new keys <code>:requires</code> and <code>:provides</code>. Values are set of top-level keys of the request. e.g.<ul>
<li><code>InjectUserIntoRequestMiddleware</code> requires <code>#{:session}</code> and provides <code>#{:user}</code></li>
<li><code>AuthorizationMiddleware</code> requires <code>#{:user}</code></li>
</ul>
</li>
</ul>
<p>Ideas welcome &amp; see <a href="https://github.com/metosin/reitit/issues" target="_blank">issues</a> for details.</p>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="dynamic_extensions.html" class="navigation navigation-prev " aria-label="Previous page: Dynamic Extensions">
<i class="fa fa-angle-left"></i>
</a>
<a href="transforming_middleware_chain.html" class="navigation navigation-next " aria-label="Next page: Transforming Middleware Chain">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Data-driven Middleware","level":"4.6","depth":1,"next":{"title":"Transforming Middleware Chain","level":"4.7","depth":1,"path":"ring/transforming_middleware_chain.md","ref":"ring/transforming_middleware_chain.md","articles":[]},"previous":{"title":"Dynamic Extensions","level":"4.5","depth":1,"path":"ring/dynamic_extensions.md","ref":"ring/dynamic_extensions.md","articles":[]},"dir":"ltr"},"config":{"plugins":["hints","editlink","github","highlight"],"root":"doc","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"github":{"url":"https://github.com/metosin/reitit"},"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/metosin/reitit/tree/master/doc"},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"*"},"file":{"path":"ring/data_driven_middleware.md","mtime":"2018-09-22T18:36:30.360Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-22T18:37:13.471Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
<script src="../gitbook/gitbook.js"></script>
<script src="../gitbook/theme.js"></script>
<script src="../gitbook/gitbook-plugin-editlink/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-github/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>