mirror of
https://github.com/metosin/reitit.git
synced 2025-12-20 09:31:11 +00:00
732 lines
20 KiB
HTML
732 lines
20 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Different Routers · 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-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="route_validation.html" />
|
|
|
|
|
|
<link rel="prev" href="configuring_routers.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="chapter " data-level="1.1" data-path="../">
|
|
|
|
<a href="../">
|
|
|
|
|
|
Introduction
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2" data-path="../basics/">
|
|
|
|
<a href="../basics/">
|
|
|
|
|
|
Basics
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.2.1" data-path="../basics/route_syntax.html">
|
|
|
|
<a href="../basics/route_syntax.html">
|
|
|
|
|
|
Route Syntax
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2.2" data-path="../basics/router.html">
|
|
|
|
<a href="../basics/router.html">
|
|
|
|
|
|
Router
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.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="1.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="1.2.5" data-path="../basics/route_data.html">
|
|
|
|
<a href="../basics/route_data.html">
|
|
|
|
|
|
Route Data
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.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="1.2.7" data-path="../basics/route_conflicts.html">
|
|
|
|
<a href="../basics/route_conflicts.html">
|
|
|
|
|
|
Route Conflicts
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3" data-path="../coercion/">
|
|
|
|
<a href="../coercion/">
|
|
|
|
|
|
Coercion
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.3.1" data-path="../coercion/coercion.html">
|
|
|
|
<a href="../coercion/coercion.html">
|
|
|
|
|
|
Coercion Explained
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.2" data-path="../coercion/schema_coercion.html">
|
|
|
|
<a href="../coercion/schema_coercion.html">
|
|
|
|
|
|
Plumatic Schema
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.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="1.3.4" data-path="../coercion/data_spec_coercion.html">
|
|
|
|
<a href="../coercion/data_spec_coercion.html">
|
|
|
|
|
|
Data-specs
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4" data-path="./">
|
|
|
|
<a href="./">
|
|
|
|
|
|
Advanced
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.1" data-path="configuring_routers.html">
|
|
|
|
<a href="configuring_routers.html">
|
|
|
|
|
|
Configuring Routers
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="1.4.2" data-path="different_routers.html">
|
|
|
|
<a href="different_routers.html">
|
|
|
|
|
|
Different Routers
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.3" data-path="route_validation.html">
|
|
|
|
<a href="route_validation.html">
|
|
|
|
|
|
Route Validation
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4" data-path="dev_workflow.html">
|
|
|
|
<a href="dev_workflow.html">
|
|
|
|
|
|
Dev Workflow
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5" data-path="../ring/">
|
|
|
|
<a href="../ring/">
|
|
|
|
|
|
Ring
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.5.1" data-path="../ring/ring.html">
|
|
|
|
<a href="../ring/ring.html">
|
|
|
|
|
|
Ring-router
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.2" data-path="../ring/default_handler.html">
|
|
|
|
<a href="../ring/default_handler.html">
|
|
|
|
|
|
Default handler
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.3" data-path="../ring/static.html">
|
|
|
|
<a href="../ring/static.html">
|
|
|
|
|
|
Static Resources
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.4" data-path="../ring/dynamic_extensions.html">
|
|
|
|
<a href="../ring/dynamic_extensions.html">
|
|
|
|
|
|
Dynamic Extensions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.5" data-path="../ring/data_driven_middleware.html">
|
|
|
|
<a href="../ring/data_driven_middleware.html">
|
|
|
|
|
|
Data-driven Middleware
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.6" data-path="../ring/coercion.html">
|
|
|
|
<a href="../ring/coercion.html">
|
|
|
|
|
|
Pluggable Coercion
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.7" data-path="../ring/route_data_validation.html">
|
|
|
|
<a href="../ring/route_data_validation.html">
|
|
|
|
|
|
Route Data Validation
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.8" data-path="../ring/compiling_middleware.html">
|
|
|
|
<a href="../ring/compiling_middleware.html">
|
|
|
|
|
|
Compiling Middleware
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5.9" data-path="../ring/swagger.html">
|
|
|
|
<a href="../ring/swagger.html">
|
|
|
|
|
|
Swagger Support
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6" data-path="../performance.html">
|
|
|
|
<a href="../performance.html">
|
|
|
|
|
|
Performance
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.7" data-path="../interceptors.html">
|
|
|
|
<a href="../interceptors.html">
|
|
|
|
|
|
Interceptors (WIP)
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.8" data-path="../development.html">
|
|
|
|
<a href="../development.html">
|
|
|
|
|
|
Development Instructions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.9" 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=".." >Different Routers</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="different-routers">Different Routers</h1>
|
|
<p>Reitit ships with several different implementations for the <code>Router</code> protocol, originally based on the <a href="https://github.com/pedestal/pedestal/tree/master/route" target="_blank">Pedestal</a> implementation. <code>router</code> function selects the most suitable implementation by inspecting the expanded routes. The implementation can be set manually using <code>:router</code> option, see <a href="advanced/configuring_routers.md">configuring routers</a>.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>router</th>
|
|
<th>description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>:linear-router</code></td>
|
|
<td>Matches the routes one-by-one starting from the top until a match is found. Slow, but works with all route trees.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>:segment-router</code></td>
|
|
<td>Router that creates a optimized <a href="https://en.wikipedia.org/wiki/Trie" target="_blank">search trie</a> out of an route table. Much faster than <code>:linear-router</code> for wildcard routes. Valid only if there are no <a href="../basics/route_conflicts.html">Route conflicts</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>:lookup-router</code></td>
|
|
<td>Fast router, uses hash-lookup to resolve the route. Valid if no paths have path or catch-all parameters and there are no <a href="../basics/route_conflicts.html">Route conflicts</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>:single-static-path-router</code></td>
|
|
<td>Super fast router: string-matches a route. Valid only if there is one static route.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>:mixed-router</code></td>
|
|
<td>Contains two routers: <code>:segment-router</code> for wildcard routes and a <code>:lookup-router</code> or <code>:single-static-path-router</code> for static routes. Valid only if there are no <a href="../basics/route_conflicts.html">Route conflicts</a>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>The router name can be asked from the router:</p>
|
|
<pre><code class="lang-clj">(<span class="hljs-name">require</span> '[reitit.core <span class="hljs-symbol">:as</span> r])
|
|
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> router
|
|
(<span class="hljs-name">r/router</span>
|
|
[[<span class="hljs-string">"/ping"</span> <span class="hljs-symbol">::ping</span>]
|
|
[<span class="hljs-string">"/api/:users"</span> <span class="hljs-symbol">::users</span>]]))
|
|
|
|
(<span class="hljs-name">r/router-name</span> router)
|
|
<span class="hljs-comment">; :mixed-router</span>
|
|
</code></pre>
|
|
<p>Overriding the router implementation:</p>
|
|
<pre><code class="lang-clj">(<span class="hljs-name">require</span> '[reitit.core <span class="hljs-symbol">:as</span> r])
|
|
|
|
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> router
|
|
(<span class="hljs-name">r/router</span>
|
|
[[<span class="hljs-string">"/ping"</span> <span class="hljs-symbol">::ping</span>]
|
|
[<span class="hljs-string">"/api/:users"</span> <span class="hljs-symbol">::users</span>]]
|
|
{<span class="hljs-symbol">:router</span> r/linear-router}))
|
|
|
|
(<span class="hljs-name">r/router-name</span> router)
|
|
<span class="hljs-comment">; :linear-router</span>
|
|
</code></pre>
|
|
|
|
|
|
</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="configuring_routers.html" class="navigation navigation-prev " aria-label="Previous page: Configuring Routers">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="route_validation.html" class="navigation navigation-next " aria-label="Next page: Route Validation">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Different Routers","level":"1.4.2","depth":2,"next":{"title":"Route Validation","level":"1.4.3","depth":2,"path":"advanced/route_validation.md","ref":"advanced/route_validation.md","articles":[]},"previous":{"title":"Configuring Routers","level":"1.4.1","depth":2,"path":"advanced/configuring_routers.md","ref":"advanced/configuring_routers.md","articles":[]},"dir":"ltr"},"config":{"plugins":["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":{"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/metosin/reitit/tree/master/doc"},"github":{"url":"https://github.com/metosin/reitit"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"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":"advanced/different_routers.md","mtime":"2018-06-06T07:44:16.728Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-06-06T07:44:51.903Z"},"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>
|
|
|