精選版：用Java擴展Nginx（nginx-clojure 入門）

来源:https://www.cnblogs.com/bolingcavalry/archive/2023/09/07/17673531.html
-Advertisement-
Play Games

讓 Java 代碼直接在 Nginx 上運行？這麼有趣的功能，隨本文一起來實戰體驗吧，圖文並茂，一定能成功的那種實戰 ...


歡迎訪問我的GitHub

這裡分類和彙總了欣宸的全部原創(含配套源碼)：https://github.com/zq2599/blog_demos

本篇概覽

  • 今天咱們以Java程式員的視角，來聊聊如何用Java來擴展Nginx的能力，全文由以下內容組成：
  1. 什麼是Nginx
  2. 什麼是Nginx擴展
  3. 擴展Nginx，意義何在？
  4. 想用Java擴展Nginx會有問題嗎？
  5. 主角登場：nginx-clojure模塊，讓Java擴展Nginx成為顯示
  • 總的來說這是一篇從概念到實踐的入門文章，接下來，一起開始愉快的nginx-clojure之旅吧！

關於Nginx

  • 以欣宸自己為例，nginx對java程式員來說並不陌生，下圖應該是最常見的使用場景了：反向代理
    在這裡插入圖片描述

關於Nginx擴展

  • 除了反向代理，nginx的模塊化機制讓nginx具備了更多豐富的特性，例如ngx_http_log_module（日誌）、ngx_http_rewrite_module（重定向）等
  • 除了官方模塊，還有很多強大第三方模塊可以選擇，如下圖，更多詳情參考：https://www.nginx.com/resources/wiki/modules/
    在這裡插入圖片描述
  • 大名鼎鼎的OpenResty就是基於 Nginx 擴展的，用Lua做二次開發web功能，得到了廣泛的應用
  • 如此看來，在nginx上做二次開發並非神秘高深莫測，我們也可以按照自己的需要去定製和擴展nginx的功能
  • 作為一名Java程式員，自然就想到了：可以用Java去擴展Nginx的能力嗎？

為什麼要用java對nginx擴展？

  • 把java代碼寫在nginx上，讓nginx與業務耦合的可能性變大，經驗豐富的您一定會發現這是個危險的趨勢，畢竟nginx已經接近後臺服務的最外層了，穩定是首要考慮的，正常情況下，下圖這種用法才是生產環境的常見fang方案：將nginx作為反向代理，業務功能獨立部署
    在這裡插入圖片描述
  • 這麼看來，在nginx上寫java代碼是否合適呢？欣宸給不出權威答案，但是可以從大神的作品中得到啟示
  • 開濤大神的《跟我學Nginx+Lua開發》講述瞭如何用OpenResty在Nginx上用Lua進行開發，適用於web應用、接入網關、Web防火牆、緩存伺服器等場景下，並且在實體書《億級流量網站架構核心技術》也有詳細說明，例如京東商品詳情頁，就是在nginx上讀取緩存直接返回的
  • 綜上所述，欣宸不會因為學習了這個技術，就把業務邏輯全部在nginx上實現，但是在緩存、鑒權等場景，可以考慮用熟悉的java在nginx上實現

Java程式員的尷尬

  • 定製Nginx，打造高性能Web服務，帶著這個美好憧憬，我打開了有關模塊開發的Nginx官方資料
  • 然後，畫風開始劇變，而且是朝著我不想面對的方向，如下圖
    在這裡插入圖片描述
  • 模塊開發用的居然是C語言！然而，欣宸只是個精通CRUD的Java程式員啊
  • 這可怎麼辦？隨手打開一個網頁就讓夢想破滅？

nginx-clojure，讓Java擴展nginx成為現實

  • 經過一番搜索，終於找到了nginx-clojure模塊，如下圖，是它讓java擴展nginx成為現實
    在這裡插入圖片描述
  • nginx-clojure的作用很好理解：OpenResty支持用Lua擴展nginx，nginx-clojure支持用Java擴展nginx
  • nginx-clojure的作用很好理解：OpenResty支持用Lua擴展nginx，nginx-clojure支持用Java擴展nginx

關於nginx-clojure

  • nginx-clojure是個第三方Nginx模塊，官方的介紹是Nginx module for embedding Clojure / Java / Groovy programs, typically those Ring based handlers
  • nginx-clojure模塊支持嵌入式Clojure(閉包)、Java、Groovy等基於Ring的處理器（handler），那什麼是Ring呢？
  • Ring 在 Clojure 中是一個構建 Web 應用的底層介面和庫. 它和 Ruby 的 Rack, Python 裡面的WSGI 或者 Java Servlet 規範相似
  • 從java開發者角度來看，就是開發NginxJavaRingHandler的實現類，然後該類可以在nginx-clojure模塊中被運行
  • nginx-clojure的最新版本是v0.5.2，官網地址是：https://nginx-clojure.github.io

實戰功能介紹

  • 儘管nginx-clojure支持很多功能，但是篇幅所限，因此本篇以瞭解為主，還是經典的Hello world，更多精彩內容留給後續的系列文章
  • 今天的實戰效果如下圖，咱們編寫HelloHandler.java併在nginx做好配置，然後用瀏覽器發起請求後，HelloHandler的代碼就會被執行，瀏覽器會收到HelloHandler返回的內容，這就證實了java代碼可以在nginx上運行：
    在這裡插入圖片描述
  • 為了實現上述功能，接下來的操作步驟如下圖：
    在這裡插入圖片描述
  • 感謝您聽我嘮叨了這麼久，接下來，實戰開始

環境信息

  • 這裡給出我的實戰環境信息供您參考，這個環境可以正常運行所有實戰：
  1. 操作系統：macOS Big Sur 11.5.2 (20G95）
  2. JDK：1.8.0_281
  3. Maven：3.8.1

下載集成了nginx-clojure模塊的nginx包

  • 咱們要做的第一件事是下載一個特別的nginx，之所以說它特別，是因為它已集成了nginx-clojure模塊，開箱即用
  • 下載地址：https://sourceforge.net/projects/nginx-clojure/files/ ，如下圖紅框，我這裡選擇的是最新的0.5.2版本：
    在這裡插入圖片描述

解壓nginx包

  • 下載完畢後，解壓，得到名為nginx-clojure-0.5.2的文件夾，裡面的內容如下
    在這裡插入圖片描述
  • 接下來根據您的操作系統對可執行文件做重命名，我這邊是macOS，所以把nginx-macosx重命名為nginx，如果是linux，把nginx-linux-64重命名為nginx，如果是windows，就把nginx-win64.exe重命名為nginx.exe
  • 上述重命名操作是nginx-clojure官方推薦的，統一可執行文件名，這樣運行文檔中的命令就統一了
  • 執行命令./nginx -v，控制台響應如下，可見nginx版本是1.18.0：
./nginx -v
nginx version: nginx/1.18.0

編碼，開發java版handler

  • 接下來開始寫代碼，先新建一個maven工程（我這裡名叫simple-hello），pom.xml中需要配置repository節點，以及唯一的依賴nginx-clojure，如下所示：
<repositories>
  <repository>
    <id>clojars.org</id>
    <url>http://clojars.org/repo</url>
    </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>nginx-clojure</groupId>
    <artifactId>nginx-clojure</artifactId>
    <version>0.5.2</version>
  </dependency>
</dependencies>
  • 然後新增文件HelloHandler.java，如下所示，代碼非常簡單，實現NginxJavaRingHandler介面，invoke方法返回的數組中只有三個元素：返回碼、響應header的鍵值對集合、響應body內容：
package com.bolingcavalry.simplehello;

import nginx.clojure.java.ArrayMap;
import nginx.clojure.java.NginxJavaRingHandler;

import java.time.LocalDateTime;
import java.util.Map;

import static nginx.clojure.MiniConstants.CONTENT_TYPE;
import static nginx.clojure.MiniConstants.NGX_HTTP_OK;

/**
 * @author [email protected]
 * @Title: 產生內容的handler
 * @Package
 * @Description:
 * @date 2/1/22 12:41 PM
 */
public class HelloHandler implements NginxJavaRingHandler {

    @Override
    public Object[] invoke(Map<String, Object> request) {
        return new Object[] {
                NGX_HTTP_OK, //http status 200
                ArrayMap.create(CONTENT_TYPE, "text/plain"), //headers map
                "Hello, Nginx clojure! " + LocalDateTime.now()  //response body can be string, File or Array/Collection of them
        };
    }
}
  • 至此，編碼完成，欣宸精通Hello World果然並非空穴來風…

編譯，生成jar

  • 在pom.xml所在目錄執行編譯構建的命令mvn clean package -U，會在target目錄下生成jar包，只有3K大小：
    在這裡插入圖片描述

jar放入nginx的jars目錄

  • 將前面生成的simple-hello-1.0-SNAPSHOT.jar文件放入下圖紅框的jars文件夾內
    在這裡插入圖片描述

修改nginx的配置

  • 打開nginx-clojure-0.5.2/conf/nginx.conf文件，在server配置中增加一個location配置，內容如下，指定了handler類型，以及對應的java類：
location /java {
         content_handler_type 'java';
         content_handler_name 'com.bolingcavalry.simplehello.HelloHandler';
}
  • 修改後，完整的nginx.conf內容如下，可見有很多java相關的配置，在本篇咱們都保持不動，留待後面的文章解鎖：
###you can uncomment next two lines for easy debug
###Warning: if master_process is off, there will be only one nginx worker running. Only use it for debug propose.

#daemon  off;

#master_process  off;

#user  nobody;
worker_processes  1;

#error_log  logs/error.log;
#error_log  logs/error.log  notice;
#error_log  logs/error.log  info;

#pid        logs/nginx.pid;


events {
    worker_connections  1024;
}


http {
    include       mime.types;
    default_type  application/octet-stream;

    #log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
    #                  '$status $body_bytes_sent "$http_referer" '
    #                  '"$http_user_agent" "$http_x_forwarded_for"';

    #access_log  logs/access.log  main;

    sendfile        on;
    #tcp_nopush     on;

    #keepalive_timeout  0;
    keepalive_timeout  65;

    #gzip  on;
    

    jvm_path auto;
    
    ### Set my app jars and resources, it must include nginx-clojure runtime jar,e.g. nginx-clojure-0.5.1.jar and 
    ### for clojure user clojure runtime jar is also needed.
    ### See http://nginx-clojure.github.io/directives.html#jvm_classpath
    jvm_classpath "libs/*:jars/*";
    
    ###jvm heap memory
    #jvm_options "-Xms1024m";
    #jvm_options "-Xmx1024m";
    
    #for enable java remote debug uncomment next two lines
    #jvm_options "-Xdebug";
    #jvm_options "-Xrunjdwp:server=y,transport=dt_socket,address=840#{pno},suspend=n";

    ###threads number for request handler thread pool on jvm, default is 0. 
    ###check more details from 
    #jvm_workers 8;

    server {
        listen       8080;
        server_name  localhost;

        #charset koi8-r;

        #access_log  logs/host.access.log  main;

        location / {
            root   html;
            index  index.html index.htm;
        }

        #error_page  404              /404.html;

        # redirect server error pages to the static page /50x.html
        #
        error_page   500 502 503 504  /50x.html;
        location = /50x.html {
            root   html;
        }

       location /clojure {
          handler_type 'clojure';
          handler_code ' 
						(fn[req]
						  {
						    :status 200,
						    :headers {"content-type" "text/plain"},
						    :body  "Hello Clojure & Nginx!" 
						    })
          ';
       }

       location /java {
         content_handler_type 'java';
         content_handler_name 'com.bolingcavalry.simplehello.HelloHandler';
       }
       
#      location /groovy {
#          handler_type 'groovy';
#          handler_code ' 
#               import nginx.clojure.java.NginxJavaRingHandler;
#               import java.util.Map;
#               public class HelloGroovy implements NginxJavaRingHandler {
#                  public Object[] invoke(Map<String, Object> request){
#                     return [200, //http status 200
#                             ["Content-Type":"text/html"], //headers map
#                             "Hello, Groovy & Nginx!"]; //response body can be string, File or Array/Collection of them
#                  }
#               }
#          ';
#       }
#         
    }
}

啟動nginx

  • 啟動命令很簡單，在nginx-clojure-0.5.2目錄下執行./nginx
  • 如果啟動失敗了，請打開nginx-clojure-0.5.2/logs/error.log查看問題，例如我這裡遇到過埠占用導致啟動失敗：
2022/02/02 17:45:07 [emerg] 27703#0: bind() to 0.0.0.0:8080 failed (48: Address already in use)
2022/02/02 17:45:07 [emerg] 27703#0: bind() to 0.0.0.0:8080 failed (48: Address already in use)
2022/02/02 17:45:07 [emerg] 27703#0: bind() to 0.0.0.0:8080 failed (48: Address already in use)
2022/02/02 17:45:07 [emerg] 27703#0: bind() to 0.0.0.0:8080 failed (48: Address already in use)
2022/02/02 17:45:07 [emerg] 27703#0: bind() to 0.0.0.0:8080 failed (48: Address already in use)
2022/02/02 17:45:07 [emerg] 27703#0: still could not bind()

驗證

  • 打開postman驗證服務是否正常，請求地址是http://127.0.0.1:8080/java
  • 響應如下圖所示，符合預期，返回的就是咱們定製的HelloHandler的內容
    在這裡插入圖片描述
  • 至此，nginx-clojure的入門操作就完成了，雖然寥寥幾行代碼，但卻給java程式員打開了一扇窗：用咱們熟悉的技術去擴展nginx，打造更符合業務的web伺服器，以最短鏈路完成web響應
  • 本篇只是nginx-clojure之旅的開端，先對nginx-clojure有個清晰的認識，接下來的文章咱們會深度探索它，讓它更好的服務於業務

源碼下載

名稱 鏈接 備註
項目主頁 https://github.com/zq2599/blog_demos 該項目在GitHub上的主頁
git倉庫地址(https) https://github.com/zq2599/blog_demos.git 該項目源碼的倉庫地址，https協議
git倉庫地址(ssh) [email protected]:zq2599/blog_demos.git 該項目源碼的倉庫地址，ssh協議
  • 這個git項目中有多個文件夾，本篇的源碼在nginx-clojure-tutorials文件夾下，如下圖紅框所示：
    在這裡插入圖片描述

歡迎關註博客園：程式員欣宸

學習路上，你不孤單，欣宸原創一路相伴...


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 由 Array.includes 函數引發對引用數據類型的思考
    `` 數組的includes方法在日常的編程中比較常用到，其作用就是判斷某一數據是否在數組中，通常來說，數組中的數據如果是數字，布爾值，或者字元串的話，都是能夠進行判斷的 例如： ``` [1,2,3,4].includes(3) // true [1,2,3,4].includes(5) // f ...
  • Vue源碼學習(二):<templete>渲染第一步,模板解析
    好家伙， 1.<template>去哪了 在正式內容之前,我們來思考一個問題, 當我們使用vue開發頁面時,<tamplete>中的內容是如何變成我們網頁中的內容的? 它會經歷四步: 解析模板：Vue會解析<template>中的內容，識別出其中的指令、插值表達式（{{}}），以及其他元素和屬性。 ...
  • 記錄--@click和@click.native有什麼區別，如何阻止第三方組件內部的冒泡
    這裡給大家分享我在網上總結出來的一些知識，希望對大家有所幫助 一.@click和@click.native的區別 vue @click.native 原生點擊事件： 1，給vue組件綁定事件時候，必須加上native ，不然不會生效（監聽根元素的原生事件，使用 .native 修飾符） 2，等同於在 ...
  • JS基礎-數據類型
    在vue3中，可以使用vue3的API `defineExpose()`函數結合`ref`或者`$parent`，實現父子組件數據的傳遞。 # 子組件向父組件傳遞數據`defineExpose()`和`ref` - 子組件：通過`defineExpose()` 函數，向外暴露響應式數據或者方法 `` ...
  • 程式員必須要知道的編程範式，你掌握了嗎？
    本文給大家介紹了什麼是"編程範式"，選擇合適的編程範式可以提高代碼的可讀性、可維護性和可擴展性。 一、 什麼是編程範式？ "編程範式"是一種編程思想的總稱，它是指在編寫程式時所採用的基本方法和規範。常見的編程範式有面向對象、函數式、邏輯式等。 選擇合適的編程範式可以提高代碼的可讀性、可維護性和可擴展 ...
  • 學習筆記-設計模式-創建型模式-工廠模式
    ### 工廠模式 工廠模式是一種創建者設計模式，細分之下可以分成三類`簡單工廠模式`，`工廠方法模式`和`抽象工廠模式`。 #### 簡單工廠模式 最簡單的工廠模式，它採用靜態方法的方式來決定應該應該生產什麼商品。 ```java public class StoreFactory { public ...
  • 快速理解DDD領域驅動設計架構思想-基礎篇
    本文與大家一起學習並介紹領域驅動設計(Domain Drive Design) 簡稱DDD，以及為什麼我們需要領域驅動設計，它有哪些優缺點，儘量用一些通俗易懂文字來描述講解領域驅動設計 ...
  • 深入淺出流批一體理論篇——數據架構的演進
    這篇文章的主要內容包括：1、數據架構的演變歷史與各種架構的優缺點。2、流批一體的價值。3、流批一體架構中流與批的關係。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類