基於url-to-pdf-api構建docker映象,製作一個網頁另存服務

天之驕子zz 發表於 2021-02-27
Docker

基於url-to-pdf-api構建docker映象,製作一個網頁另存服務

業務背景:

需要根據一個url路徑列印這個網頁的內容

解決方案:

1.使用wkhtml2pdf

2.使用puppeteer

根據網上的資料,wkhtml2pdf 可以安裝在linux伺服器,通過java api呼叫linux命令即可使用。但似乎對SPA(單頁面應用)支援不是很好。puppeteer是谷歌出品,可以模擬谷歌引擎,支援SPA,列印效果較好。

原始碼下載

根據某前端大佬指教,可以根據開源的 url-to-pdf-api 進行網頁另存,其原理是封裝了 puppeteer 進行網頁抓取,大喜!!!
下載url-to-pdf-api原始碼(https://github.com/alvarcarto/url-to-pdf-api)
本地安裝node環境即可測試網頁列印。但是這個服務需要安裝至linux伺服器,需要安裝node並且通過npm install 安裝node_modules,較複雜,使用docker打包成映象可以解決這個問題。

docker映象製作

開始時,我的Dockerfile寫法是這樣的

FROM node:latest
WORKDIR /app

# copy package.json into the new directory
COPY package.json /app

# install the dependencies
RUN npm install

# copy all other files into the app directory
COPY . /app

#配置環境變數
ENV HOST 0.0.0.0
ENV PORT 9005
ENV NODE_ENV production
ENV ALLOW_HTTP true
ENV DEBUG_MODE false
# open port 9000
EXPOSE 9005

# run the server
CMD node ./src/index.js
#CMD [ "npm", "start"]

但是我在啟動映象例項之後,測試無法使用,檢視映象例項日誌,關鍵的一行錯誤資訊如下:

Error: Failed to launch the browser process

通過網上的資料,我發現和我問題相似的部落格:https://www.jianshu.com/p/2c88eb7459a4
根據該部落格,我修改了Dockerfile,內容如下:

FROM node:latest

# 注意改 source-sans-pro.zip
# 這一步是需要先下載source-sans-pro-3.006R.zip的,由於我已經下載並解壓,所以寫法是這樣
COPY ./source-sans-pro-3.006R/ /usr/share/fonts/
RUN sed -i 's/deb.debian.org/mirrors.163.com/g' /etc/apt/sources.list && \
    apt update && \
    apt-get install -y dpkg wget unzip

# 2. https://github.com/puppeteer/puppeteer/blob/master/.ci/node10/Dockerfile.linux
RUN apt-get update && \
    apt-get -y install xvfb gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 \
      libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 \
      libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 \
      libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 \
      libxtst6 ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget && \
    rm -rf /var/lib/apt/lists/*
# create a directory to run docker
WORKDIR /app

# copy package.json into the new directory
COPY package.json /app

# install the dependencies
RUN npm install

# copy all other files into the app directory
COPY . /app

#配置環境變數
ENV HOST 0.0.0.0
ENV PORT 9005
ENV NODE_ENV production
ENV ALLOW_HTTP true
ENV DEBUG_MODE false
# open port 9000
EXPOSE 9005

# run the server
CMD node ./src/index.js
#CMD [ "npm", "start"]

通過如下連結測試使用:

http://localhost:9005/api/render?url=https://www.baidu.com

出現問題,截圖中的中文都是小方框,亂碼。應該是中文字型不正確。
可以使用兩種方式解決:
1.啟動映象例項後,使用docker cp複製中文字型至映象內,重啟例項
2.啟動例項時掛載宿主機字型目錄到映象例項字型目錄

我選擇了第二種方式解決,我的docker 啟動映象例項命令如下:

docker run -itd -p 9005:9005  -v /usr/share/fonts:/usr/share/fonts --name url2pdf-v6 docker-url2pdf:v6

映象匯出

由於,需要在其他宿主機中安裝該映象,可以使用docker save匯出映象

先將映象檔案儲存為tar檔案
docker save -o docker-url2pdf.tar docker-url2pdf:v6

使用該命令後,會在當前目錄下產生一個docker-url2pdf.tar 檔案,但該檔案很大,不利於網路傳輸,可以使用gzip命令進一步壓縮

使用gzip壓縮檔案
gzip docker-url2pdf.tar

壓縮完成後將檔案傳輸到宿主機後解壓檔案

gunzip docker-url2pdf.tar.gz

匯入映象即可使用,匯入映象命令如下:

docker load < docker-url2pdf.tar

還未解決的問題:

url-to-pdf-api 在使用的時候支援很多引數,也支援cookie。但是我們在傳遞cookie時沒有成功,尷尬!!!

參考連結:

https://github.com/alvarcarto/url-to-pdf-api
https://www.jianshu.com/p/2c88eb7459a4
https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-in-docker
https://github.com/adobe-fonts/source-sans

注意點:

1.需要找到以下程式碼並註釋掉

page.on('console', (...args) => logger.info('PAGE LOG:', ...args));

該程式碼會列印大量日誌,影響效能

2.如果列印出的網頁中文亂碼,需要檢視映象字型檔案是否安裝正確,如果不正確可以通過複製字型檔案到容器例項內,
或者啟動時掛載宿主機中文字型檔案目錄即可進行補救。