超越Nginx的Web服務器caddy優雅用法

Posted on 2022-06-20 by WalkonNet

前言

Nginx是一款非常流行的Web服務器，在Github上已有16K+Star，我們經常用它來做靜態資源托管或反向代理。最近發現瞭一款全新的Web服務器Caddy，Star數超越Nginx，標星38K+Star。試用瞭一下Caddy，發現它使用起來比Nginx優雅多瞭，功能也很強大，推薦給大傢！

SpringBoot實戰電商項目mall（50k+star）地址：https://github.com/macrozheng/mall

Caddy簡介

Caddy是一款功能強大，擴展性高的Web服務器，目前在Github上已有38K+Star。Caddy采用Go語言編寫，可用於靜態資源托管和反向代理。

Caddy具有如下主要特性：

對比Nginx復雜的配置，其獨創的Caddyfile配置非常簡單；
可以通過其提供的Admin API實現動態修改配置；
默認支持自動化HTTPS配置，能自動申請HTTPS證書並進行配置；
能夠擴展到數以萬計的站點；
可以在任意地方執行，沒有額外的依賴；
采用Go語言編寫，內存安全更有保證。

安裝

首先我們直接在CentOS 8上安裝Caddy，使用DNF工具安裝無疑是最簡單的，Docker安裝方式之後也會介紹。

使用如下命令通過DNF工具安裝Caddy，安裝成功後Caddy會被註冊成系統服務；

dnf install 'dnf-command(copr)'
dnf copr enable @caddy/caddy
dnf install caddy

使用systemctl status caddy查看Caddy的狀態，可以發現Caddy已被註冊為系統服務，但是還沒開啟。

使用

下面我們體驗下Caddy的基本使用，對於Web服務器來說都是常用的操作，你準能用的上！

基本使用

首先我們來個Caddy的入門使用，讓Caddy運行在2015端口上並返回Hello, world!。

直接使用caddy命令將輸出Caddy的常用命令，基本看介紹就知道如何使用瞭，標出來的是常用命令；

使用caddy start命令可以讓Caddy服務在後臺運行；

Caddy默認使用JSON格式的配置文件，但由於JOSN格式配置書寫比較麻煩，又提供瞭Caddyfile這種更加簡潔的配置形式，使用如下命令能自動把Caddyfile轉化為JSON配置；

caddy adapter

我們可以先創建一個名稱為Caddyfile的文件，文件內容如下，然後使用caddy adapter將它轉換為JSON配置，再使用caddy reload使配置生效，該配置將監聽2015端口，並返回Hello, world!；

:2015

respond "Hello, world!"

然後我們使用curl命令訪問localhost:2015，將返回指定的信息；

當然我們還可以使用Caddy提供的Admin API來查看配置信息，使用如下命令即可；

curl localhost:2019/config/

當前JSON配置如下，如果你直接使用JSON配置的話需要書寫如下配置，使用Caddyfile確實方便很多！

{
	"apps": {
		"http": {
			"servers": {
				"srv0": {
					"listen": [":2015"],
					"routes": [{
						"handle": [{
							"body": "Hello, world!",
							"handler": "static_response"
						}]
					}]
				}
			}
		}
	}
}

Caddyfile基本語法

下面案例將使用Caddyfile來進行配置，我們有必要瞭解下它的語法，Caddyfile的具體語法規則如下。

介紹下上圖中的關鍵字，有助於理解。

關鍵字	解釋	使用
Global options block	服務器全局配置	可用於配置是否啟用HTTPS和Admin API等
Snippet	可以復用的配置片段	定義好後認可以通過`import`關鍵字引用
Site Block	單個網站配置	通過`file_server`可以配置靜態代理，通過`reverse_proxy`可以配置動態代理
Matcher definition	匹配定義	默認情況下指令會產生全局影響，通過它可以指定影響范圍
Comment	註釋	使用`#`符號開頭
Site address	網站地址	默認使用HTTPS，如需開啟HTTP，需要指定`http://`開頭
Directive	指令	指令賦予瞭Caddy強大的功能

反向代理

反向代理就是當請求訪問你的代理服務器時，代理服務器會對你的請求進行轉發，可以轉發到靜態的資源路徑上去，也可以轉發到動態的服務接口上去。下面我們以對域名進行代理為例，來講講如何進行靜態代理和動態代理。

靜態代理

靜態代理就是將請求代理到不同的靜態資源路徑上去，這裡我們將對docs.macrozheng.com的請求代理到我的文檔項目中，對mall.macrozheng.com的請求代理到mall的前端項目中。

首先我們修改下本機的host文件：

192.168.3.106 docs.macrozheng.com
192.168.3.106 mall.macrozheng.com

然後將我們的文檔項目和mall前端項目上傳到Caddy的html目錄中去，並進行解壓操作：

修改Caddyfile文件，使用如下配置，修改完成後使用caddy reload命令刷新配置；

http://docs.macrozheng.com {
        root * /mydata/caddy/html/docs
        file_server browse
}

http://mall.macrozheng.com {
        root * /mydata/caddy/html/mall
        file_server browse
}

如果你的Caddyfile文件格式不太合格的話，會出現如下警告，直接使用caddy fmt --overwrite格式化並重寫配置即可解決；

通過docs.macrozheng.com即可訪問部署好的文檔項目瞭：

通過mall.macrozheng.com即可訪問到部署好的前端項目瞭。

動態代理

動態代理就是把代理服務器的請求轉發到另一個服務上去，這裡我們將把對api.macrozheng.com的請求代理到演示環境的API服務上去。

首先我們修改下本機的host文件，添加如下規則

192.168.3.106 api.macrozheng.com

修改Caddyfile文件，使用如下配置，修改完成後使用caddy reload命令刷新配置；

http://api.macrozheng.com {
        reverse_proxy http://admin-api.macrozheng.com
}

之後通過api.macrozheng.com/swagger-ui.html即可訪問到mall-admin的API文檔頁面瞭。

文件壓縮

如果我們的服務器帶寬比較低，網站訪問速度會很慢，這時我們可以通過讓Caddy開啟Gzip壓縮來提高網站的訪問速度。這裡我們以mall的前端項目為例來演示下它的提速效果。

我們需要修改Caddyfile文件，使用encode指令開啟Gzip壓縮，修改完成後使用caddy reload命令刷新配置；

http://mall.macrozheng.com {
        root * /mydata/caddy/html/mall
        encode {
            gzip
        }
        file_server browse
}

有個比較大的JS文件壓縮前是1.7M；

壓縮後為544K，訪問速度也有很大提示；

另外我們可以看下響應信息，如果有Content-Encoding: gzip這個響應頭表明Gzip壓縮已經啟用瞭。

地址重寫

有的時候我們的網站更換瞭域名，但還有用戶在使用老的域名訪問，這時可以通過Caddy的地址重寫功能來讓用戶跳轉到新的域名進行訪問。

我們需要修改Caddyfile文件，使用redir指令重寫地址，修改完成後使用caddy reload命令刷新配置；

http://docs.macrozheng.com {
        redir http://www.macrozheng.com
}

此時訪問舊域名docs.macrozheng.com會直接跳轉到www.macrozheng.com去。

按目錄劃分

有時候我們需要使用同一個域名來訪問不同的前端項目，這時候就需要通過子目錄來區分前端項目瞭。

比如說我們需要按以下路徑來訪問各個前端項目；

www.macrozheng.com #訪問文檔項目
www.macrozheng.com/admin #訪問後臺項目
www.macrozheng.com/app #訪問移動端項目

我們需要修改Caddyfile文件，使用route指令定義路由，修改完成後使用caddy reload命令刷新配置。

http://www.macrozheng.com {
        route /admin/* {
                uri strip_prefix /admin
                file_server {
                        root /mydata/caddy/html/admin
                }
        }
        route /app/* {
                uri strip_prefix /app
                file_server {
                        root /mydata/caddy/html/app
                }
        }
        file_server * {
                root /mydata/caddy/html/www
        }
}

HTTPS

Caddy能自動支持HTTPS，無需手動配置證書，這就是之前我們在配置域名時需要使用http://開頭的原因，要想使用Caddy默認的HTTPS功能，按如下步驟操作即可。

首先我們需要修改域名的DNS解析，直接在購買域名的網站上設置即可，這裡以docs.macrozheng.com域名為例；

之後使用如下命令驗證DNS解析記錄是否正確，註意配置的服務器的80和443端口需要在外網能正常訪問；

curl "https://cloudflare-dns.com/dns-query?name=docs.macrozheng.com&type=A" \
  -H "accept: application/dns-json"

修改Caddyfile配置文件，進行如下配置；

docs.macrozheng.com {
        root * /mydata/caddy/html/docs
        file_server browse
}

然後使用caddy run命令啟動Caddy服務器即可，是不是非常方便！

caddy run

Docker支持

當然Caddy也是支持使用Docker進行安裝使用的，其使用和直接在CentOS上安裝基本一致。

首先使用如下命令下載Caddy的Docker鏡像；

docker pull caddy

然後在/mydata/caddy/目錄下創建Caddyfile配置文件，文件內容如下；

http://192.168.3.105:80

respond "Hello, world!"

之後使用如下命令啟動caddy服務，這裡將宿主機上的Caddyfile配置文件、Caddy的數據目錄和網站目錄掛載到瞭容器中；

docker run -p 80:80 -p 443:443 --name caddy \
    -v /mydata/caddy/Caddyfile:/etc/caddy/Caddyfile \
    -v /mydata/caddy/data:/data \
    -v /mydata/caddy/html:/usr/share/caddy \
    -d caddy

之後使用docker exec進入caddy容器內部執行命令；

docker exec -it caddy /bin/sh

輸入Caddy命令即可操作，之後的操作就和我們直接在CentOS上安裝一樣瞭。

總結

今天體驗瞭一把Caddy，其強大的指令功能，讓我們無需多餘的配置即可實現各種功能，使用起來確實非常優雅！尤其是其能自動配置實現HTTPS，非常不錯！Nginx能實現的功能Caddy基本都能實現，大傢可以對比下之前寫的Nginx使用教程，你就會發現使用Caddy來實現有多麼優雅！

參考資料

項目地址：https://github.com/caddyserver/caddy

官方文檔：https://caddyserver.com/

更多關於caddy服務器的資料請關註WalkonNet其它相關文章！

超越Nginx的Web服務器caddy優雅用法

目錄

前言

Caddy簡介

Caddy具有如下主要特性：

安裝

使用

基本使用

Caddyfile基本語法

反向代理

靜態代理

動態代理

文件壓縮

地址重寫

按目錄劃分

HTTPS

Docker支持

總結

推薦閱讀：

發佈留言取消回覆

近期文章

目錄

前言

Caddy簡介

Caddy具有如下主要特性：

安裝

使用

基本使用

Caddyfile基本語法

反向代理

靜態代理

動態代理

文件壓縮

地址重寫

按目錄劃分

HTTPS

Docker支持

總結

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆