Java擴充套件Nginx之二:編譯nginx-clojure原始碼

2023-07-10 09:01:40

歡迎存取我的GitHub

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

為什麼要編譯nginx-clojure原始碼

  • 作為《Java擴充套件Nginx》的第二篇,本想與大家一起開始nginx-clojure的深度之旅,但有個問題若不解決,會讓大多數有興趣的讀者立即止步、關閉網頁、再也不見
  • 前文咱們使用的是nginx-clojure官方的安裝包,這是個編譯好的nginx可執行檔案,開箱即用,當時我們還用命令檢視過nginx版本是1.18.0,如下圖:
  • 直接使用nginx-clojure官方編譯好的安裝包,雖然好處是簡單省事兒,但同樣帶來一些致命問題,導致咱們不敢將其用於生產環境,其實相信聰明的您已經想到了:
  1. 如果nginx1.18.0被曝出有安全問題,需要升級到更高版本,咋辦?寄希望於nginx-clojure官方推出更高nginx版本的包嗎?
  2. 如果說問題1可以通過等待來解決,那麼,假設咱們的nginx不僅需要nginx-clojure能力,還需要整合其他第三方或者自研模組,那又該如何呢?
  • 所以,nginx-clojure提供的安裝包,只能作為一個學習工具,幫助咱們熟悉nginx-clojure技術框架,或者在開發的時候用到,至於生產環境就不適合了
  • 此刻,經驗豐富的您一定看出了欣宸的套路:囉囉嗦嗦、拐彎抹角扯了這麼多,可以給出解決方案了吧,嗯嗯,既要用上nginx-clojure,又要避免上述兩個致命問題,最合適的方案應該是:下載nginx和nginx-clojure的原始碼,自行編譯和安裝

本篇概覽

  • 本篇的主題十分明確,就是編譯原始碼和安裝,所以整體上由以下幾部分組成:
  1. 準備環境
  2. 編譯安裝操作
  3. 驗證功能
  • 本次實戰,所用nginx原始碼的版本是1.21.6,nginx-clojure原始碼的版本是0.5.2

  • 整個編譯和驗證的過程,由以下步驟組成:

  • 不說廢話,直接開始動手

準備環境

  • 建議準備一個純淨的linux環境用來實戰,我這裡是租用的騰訊雲輕應用伺服器,安裝了CentOS7.6,話說這輕應用伺服器還真的方便,價格便宜,重灌系統也很簡單,如下圖:
  • 為了省事兒,全程使用root賬號
  • 遠端連線騰訊雲服務的使用者端工具是FinalShell-3.9.2.2

安裝jdk

  • nginx-clojure的原始碼中有java檔案,因此要準備好JDK用於編譯
  • 去oracle官網下載jdk安裝包,例如jdk-8u291-linux-x64.tar.gz,將其上傳到linux伺服器
  • 解壓,移動到指定目錄:
tar -zxvf jdk-8u291-linux-x64.tar.gz \
&& mkdir -p /usr/lib/jvm/ \
&& mv jdk1.8.0_291 /usr/lib/jvm/
  • 開啟.bashrc,在尾部增加以下內容:
export JAVA_HOME=/usr/lib/jvm/jdk1.8.0_291
export JRE_HOME=${JAVA_HOME}/jre
export CLASSPATH=.:${JAVA_HOME}/lib:${JRE_HOME}/lib
export PATH=${JAVA_HOME}/bin:$PATH
  • 執行source .bashrc使得設定生效
  • 檢查是否安裝成功,如下:
[root@VM-20-17-centos ~]# java -version
java version "1.8.0_291"
Java(TM) SE Runtime Environment (build 1.8.0_291-b10)
Java HotSpot(TM) 64-Bit Server VM (build 25.291-b10, mixed mode)

準備編譯nginx所需的應用

  • 更新yum:
yum update -y
  • 安裝必要的應用:
yum install -y epel-release \
vim \
net-tools \
bridge-utils \
firewalld \
bc \
iotop \
bc \
gcc \
gcc-c++ \
glibc \
glibc-devel \
pcre \
pcre-devel \
openssl \
openssl-devel \
zip \
unzip \
zlib-devel \
lrzsz \
tree \
ntpdate \
telnet \
lsof \
tcpdump \
wget \
libevent \
libevent-devel \
systemd-devel \
bash-completion \
traceroute \
psmisc

安裝lein

  • lein是編譯nginx-clojure原始碼時用到的工具

  • 安裝步驟如下:

curl -o /usr/bin/lein https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein \
&& chmod a+x /usr/bin/lein \
&& lein
[root@VM-20-17-centos ~]# lein -version
WARNING: You have $CLASSPATH set, probably by accident.
It is strongly recommended to unset this before proceeding.
Leiningen 2.9.8 on Java 1.8.0_291 Java HotSpot(TM) 64-Bit Server VM

下載nginx和nginx-clojure原始碼

  • 用一行命令搞定下載nginx和nginx-clojure原始碼的壓縮包,並將它們分別解壓,然後刪除壓縮包:
cd ~ \
&& curl -O http://nginx.org/download/nginx-1.21.6.tar.gz \
&& curl -o nginx-clojure-0.5.2.zip https://codeload.github.com/nginx-clojure/nginx-clojure/zip/refs/tags/v0.5.2 \
&& tar -zxvf nginx-1.21.6.tar.gz \
&& unzip nginx-clojure-0.5.2.zip \
&& rm -f nginx-1.21.6.tar.gz nginx-clojure-0.5.2.zip
  • 此刻新增了兩個資料夾,它們的完整路徑分別是/root/nginx-1.21.6/root/nginx-clojure-0.5.2,前者是nginx原始碼,後者是nginx-clojure模組的原始碼

編譯和安裝nginx

  • 執行以下命令,完成設定、編譯、安裝,注意add-module引數,裡面指定了nginx-clojure模組的原始碼位置:
cd ~/nginx-1.21.6 \
&& ./configure  \
--prefix=/usr/local/nginx  \
--sbin-path=/usr/local/nginx/sbin/nginx \
--conf-path=/usr/local/nginx/conf/nginx.conf \
--error-log-path=/var/log/nginx/error.log  \
--http-log-path=/var/log/nginx/access.log  \
--pid-path=/var/run/nginx/nginx.pid \
--lock-path=/var/lock/nginx.lock  \
--user=nginx --group=nginx \
--with-http_ssl_module \
--with-http_stub_status_module \
--with-http_gzip_static_module \
--http-client-body-temp-path=/var/tmp/nginx/client/ \
--http-proxy-temp-path=/var/tmp/nginx/proxy/ \
--http-fastcgi-temp-path=/var/tmp/nginx/fcgi/ \
--http-uwsgi-temp-path=/var/tmp/nginx/uwsgi \
--http-scgi-temp-path=/var/tmp/nginx/scgi \
--with-pcre \
--add-module=/root/nginx-clojure-0.5.2/src/c \
&& make \
&& make install
  • 還要增加名為nginx的使用者組和使用者:
groupadd nginx && useradd -d /home/nginx -g nginx -m nginx
  • 建立必要的資料夾:
mkdir -p /var/tmp/nginx/client
  • 此時nginx已經安裝好了,驗證一下:
[root@VM-20-17-centos ~]# /usr/local/nginx/sbin/nginx -version
nginx version: nginx/1.21.6

編譯nginx-clojure的jar包

  • 二進位制的nginx編譯已經完成,還需要nginx-clojure模組的原始碼,得到的jar在執行時要用,執行以下命令:
cd ~/nginx-clojure-0.5.2 \
&& lein jar
  • 編譯構建成功後,將得到的jar檔案放入新建的目錄/usr/local/nginx/jars
mkdir /usr/local/nginx/jars \
&& mv ~/nginx-clojure-0.5.2/target/nginx-clojure-0.5.2.jar /usr/local/nginx/jars/

安裝clojure的jar包

  • nginx-clojure在執行的時候還要用到clojure-1.7.0.jar,我將其放在自己的GitHub倉庫了,下載並放入新建的目錄/usr/local/nginx/libs
mkdir /usr/local/nginx/libs \
&& curl -o /usr/local/nginx/libs/clojure-1.7.0.jar https://raw.githubusercontent.com/zq2599/blog_download_files/master/files/clojure-1.7.0.jar
  • 至此,完整的nginx和nginx-clojure已經安裝完成,接下來驗證是否可用

驗證

  • 既然是驗證nginx-clojure是否可用,簡簡單單就好,就用前文的Hello World功能吧
  • 前文的jar包,我已經上傳到GitHub上,下載到/usr/local/nginx/jars/目錄下:
curl -o /usr/local/nginx/jars/simple-hello-1.0-SNAPSHOT.jar https://raw.githubusercontent.com/zq2599/blog_download_files/master/files/simple-hello-1.0-SNAPSHOT.jar
  • 還要修改/usr/local/nginx/conf/nginx.conf,先在http的設定中增加以下兩行:
  jvm_path auto;
  jvm_classpath "/usr/local/nginx/libs/*:/usr/local/nginx/jars/*";
  • 然後在server的設定中增加一個location:
location /java {
  content_handler_type 'java';
  content_handler_name 'com.bolingcavalry.simplehello.HelloHandler';
}
  • 完整的/usr/local/nginx/conf/nginx.conf內容如下:
#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;
    jvm_classpath "/usr/local/nginx/libs/*:/usr/local/nginx/jars/*";

    server {
        listen       80;
        server_name  localhost;

        #charset koi8-r;

        #access_log  logs/host.access.log  main;

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

        location /java {
         content_handler_type 'java';
         content_handler_name 'com.bolingcavalry.simplehello.HelloHandler';
       }

        #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;
        }

        # proxy the PHP scripts to Apache listening on 127.0.0.1:80
        #
        #location ~ \.php$ {
        #    proxy_pass   http://127.0.0.1;
        #}

        # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
        #
        #location ~ \.php$ {
        #    root           html;
        #    fastcgi_pass   127.0.0.1:9000;
        #    fastcgi_index  index.php;
        #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
        #    include        fastcgi_params;
        #}

        # deny access to .htaccess files, if Apache's document root
        # concurs with nginx's one
        #
        #location ~ /\.ht {
        #    deny  all;
        #}
    }

    # another virtual host using mix of IP-, name-, and port-based configuration
    #
    #server {
    #    listen       8000;
    #    listen       somename:8080;
    #    server_name  somename  alias  another.alias;

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

    # HTTPS server
    #
    #server {
    #    listen       443 ssl;
    #    server_name  localhost;

    #    ssl_certificate      cert.pem;
    #    ssl_certificate_key  cert.key;

    #    ssl_session_cache    shared:SSL:1m;
    #    ssl_session_timeout  5m;

    #    ssl_ciphers  HIGH:!aNULL:!MD5;
    #    ssl_prefer_server_ciphers  on;

    #    location / {
    #        root   html;
    #        index  index.html index.htm;
    #    }
    #}
}
  • 啟動nginx,命令是/usr/local/nginx/sbin/nginx
  • 直接在伺服器上用curl命令驗證,命令是curl 127.0.0.1/java,響應如下圖紅框,可見服務正常,咱們寫的java類被正常呼叫並且返回了預期的內容:
  • 至此,nginx和nginx-clojure的原始碼編譯以及驗證都完成了,既然可以自由的編譯原始碼,那麼之前提到的安全、與其他模組共存的問題也就得以解決,接下來,咱們會深入研究nginx-clojure,以便更好的擴充套件nginx為實際專案所用。

歡迎關注部落格園:程式設計師欣宸

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