NestJs 靜態(tài)目錄配置詳解
網(wǎng)上查看了很多文檔,發(fā)現(xiàn)很多都是自己實(shí)現(xiàn)中間件來(lái)完成此功能,不僅浪費(fèi)時(shí)間,而且增加了太多的代碼量。實(shí)際上,nest已經(jīng)幫助我們封裝好了相關(guān)功能。
1、查找線索
由于官方文檔沒(méi)有做詳細(xì)解釋說(shuō)明,那么我們可以從此框架底層入手:
我們知道,nestjs底層用的是express,那么express是通過(guò)什么來(lái)完成靜態(tài)目錄構(gòu)建的:
serve-static
2、搜索源碼
我們?cè)陧?xiàng)目搜索欄目中搜索“serve-static”會(huì)發(fā)現(xiàn)如下圖:
也就是說(shuō),當(dāng)我們?cè)谑褂胣est框架的時(shí)候,serve-static 會(huì)隨之而構(gòu)建好,那么我們直接參考其源碼即可:依賴地址
Nestjs 源碼:
// Type definitions for serve-static 1.13 // Project: https://github.com/expressjs/serve-static // Definitions by: Uros Smolnik <https://github.com/urossmolnik> // Linus Unnebäck <https://github.com/LinusU> // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 /* =================== USAGE =================== import * as serveStatic from "serve-static"; app.use(serveStatic("public/ftp", {"index": ["default.html", "default.htm"]})) =============================================== */ /// <reference types="express-serve-static-core" /> import * as express from "express-serve-static-core"; import * as m from "mime"; /** * Create a new middleware function to serve files from within a given root directory. * The file to serve will be determined by combining req.url with the provided root directory. * When a file is not found, instead of sending a 404 response, this module will instead call next() to move on to the next middleware, allowing for stacking and fall-backs. */ declare function serveStatic(root: string, options?: serveStatic.ServeStaticOptions): express.Handler; declare namespace serveStatic { var mime: typeof m; interface ServeStaticOptions { /** * Enable or disable setting Cache-Control response header, defaults to true. * Disabling this will ignore the immutable and maxAge options. */ cacheControl?: boolean; /** * Set how "dotfiles" are treated when encountered. A dotfile is a file or directory that begins with a dot ("."). * Note this check is done on the path itself without checking if the path actually exists on the disk. * If root is specified, only the dotfiles above the root are checked (i.e. the root itself can be within a dotfile when when set to "deny"). * The default value is 'ignore'. * 'allow' No special treatment for dotfiles * 'deny' Send a 403 for any request for a dotfile * 'ignore' Pretend like the dotfile does not exist and call next() */ dotfiles?: string; /** * Enable or disable etag generation, defaults to true. */ etag?: boolean; /** * Set file extension fallbacks. When set, if a file is not found, the given extensions will be added to the file name and search for. * The first that exists will be served. Example: ['html', 'htm']. * The default value is false. */ extensions?: string[]; /** * Let client errors fall-through as unhandled requests, otherwise forward a client error. * The default value is false. */ fallthrough?: boolean; /** * Enable or disable the immutable directive in the Cache-Control response header. * If enabled, the maxAge option should also be specified to enable caching. The immutable directive will prevent supported clients from making conditional requests during the life of the maxAge option to check if the file has changed. */ immutable?: boolean; /** * By default this module will send "index.html" files in response to a request on a directory. * To disable this set false or to supply a new index pass a string or an array in preferred order. */ index?: boolean | string | string[]; /** * Enable or disable Last-Modified header, defaults to true. Uses the file system's last modified value. */ lastModified?: boolean; /** * Provide a max-age in milliseconds for http caching, defaults to 0. This can also be a string accepted by the ms module. */ maxAge?: number | string; /** * Redirect to trailing "/" when the pathname is a dir. Defaults to true. */ redirect?: boolean; /** * Function to set custom headers on response. Alterations to the headers need to occur synchronously. * The function is called as fn(res, path, stat), where the arguments are: * res the response object * path the file path that is being sent * stat the stat object of the file that is being sent */ setHeaders?: (res: express.Response, path: string, stat: any) => any; } function serveStatic(root: string, options?: ServeStaticOptions): express.Handler; } export = serveStatic;
3、使用方式:
說(shuō)明:源碼中的注釋說(shuō)的很清楚用法,由于現(xiàn)階段技術(shù)有限,博主將項(xiàng)目目錄作為文件地址來(lái)簡(jiǎn)單的使用。
代碼使用:只需要一句代碼:
在 main.ts文件中:
//... import * as serveStatic from 'serve-static'; async function bootstrap() { const app = await NestFactory.create(AppModule); //.... // 使用serve-static // '/public' 是路由名稱,即你訪問(wèn)的路徑為:host/public // serveStatic 為 serve-static 導(dǎo)入的中間件,其中'../public' 為本項(xiàng)目相對(duì)于src目錄的絕對(duì)地址 app.use('/public', serveStatic(path.join(__dirname, '../public'), { maxAge: '1d', extensions: ['jpg', 'jpeg', 'png', 'gif'], })); //.... await app.startAllMicroservicesAsync(); await app.listen(9871); } bootstrap();
在項(xiàng)目根目錄下創(chuàng)建public目錄:
目錄創(chuàng)建.png
4、測(cè)試效果:
首先使用nestjs自帶的upload api來(lái)上傳文件,這里不做過(guò)多說(shuō)明,最終通過(guò)postman完成測(cè)試文件上傳:
測(cè)試上傳.png
再使用瀏覽器瀏覽:
瀏覽圖片.gif
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
JS實(shí)現(xiàn)FLASH幻燈片圖片切換效果的方法
這篇文章主要介紹了JS實(shí)現(xiàn)FLASH幻燈片圖片切換效果的方法,實(shí)例分析了javascript操作圖片實(shí)現(xiàn)Flash幻燈效果的技巧,需要的朋友可以參考下2015-03-03javascript css紅色經(jīng)典選項(xiàng)卡效果實(shí)現(xiàn)代碼
這篇文章主要為大家詳細(xì)介紹了javascript css紅色經(jīng)典選項(xiàng)卡效果的實(shí)現(xiàn)代碼,需要的朋友可以參考下2016-05-05JS 調(diào)試中常見(jiàn)的報(bào)錯(cuò)問(wèn)題解決方法
下面小編就為大家?guī)?lái)一篇JS 調(diào)試中常見(jiàn)的報(bào)錯(cuò)問(wèn)題解決方法。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-05-05淺析JavaScript定時(shí)器setTimeout的時(shí)延問(wèn)題
這篇文章主要為大家詳細(xì)介紹了JavaScript中定時(shí)器setTimeout有最小時(shí)延的相關(guān)知識(shí),文中的示例代碼簡(jiǎn)潔易懂,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-11-11javascript自然分類法算法實(shí)現(xiàn)代碼
這篇文章介紹了javascript自然分類法算法實(shí)現(xiàn)代碼,有需要的朋友可以參考一下2013-10-10