Oct 06, 2022
Oct 06, 2022
Stop your Next.js middleware from running on static assets like images and Next.js internals
Next.js middleware is incredibly powerful, but by default it runs on more requests than is normally necessary. To see this in action, you can add a simple logger:
Here's the log for loading http://localhost:3000/ on a brand new Next.js application:
The log shows several static assets that you probably don't want to process in your middleware, and doing so could break your application. To solve this, you can configure a matcher, which tells your middleware to only run on requests that match a certain pattern.
To prevent middleware from running on static files, you can leverage a simple trick: static files have a
. in the path, while dynamic files do not.
With a regular expression, you can configure middleware to run on every file that does not contain a
With this matcher, the log only shows one request:
This matcher is a great starting point that minimizes middleware invocation. As your application grows, though, you may need to tweak it. Below are the two most common revisions.
The easiest way to include some static assets in middleware is to retain the exclusionary regular expression, but define an additional matcher. Here's a sample that excludes all static assets from middleware except
Sometimes you will want to filter more than just static files. This can be done in two ways:
Expanding the regular expression prevents additional middleware invocations, but regular expressions are also harder to read and write. Here's an example that excludes API routes in addition to static assets:
A more readable approach is to create a conditional statement, but this will waste compute resources since your middleware will be unnecessarily invoked. Here's an example:
This should be everything you need to get started on the right foot with middleware!
Start completely free for up to 5,000 monthly active users and up to 10 monthly active orgs. No credit card required.
Learn more about our transparent per-user costs to estimate how much your company could save by implementing Clerk.
The latest news and updates from Clerk, sent to your inbox.