hi-project

hi-project是一个创建hi-nginx模板化工程的脚本。—help可查看使用方法:

  2. $1:project name.
  3.     default:demo
  4. $2:type:cpp,python,lua ,php , java, javascript or duktape
  5.     default:cpp
  6. $3:hi(nginx) install directory.
  7.     default:/usr/local/nginx

它接受三个参数来创建工程，使用make,make clean和sudo make install来完成工程构建、清理和安装。必要时，可以通过修改Makefile来添加自定义行为。

举个例子。我想创建一个hi-nginx-cpp工程。

  • 第一步,mkdir test && cd test，test目录作为全部hi-nginx工程的根目录。
  • 第二步,/usr/local/nginx/sbin/hi-project demo cpp /usr/local/nginx,会看到一个demo目录被创建里面有cpp 模板源码和Makefile。后两个参数因为是默认值，可省略。
  • 第三步，make,正确无误就可以sudo make install。
  • 第四步， 修改nginx 配置，启用编译生成的demo.so，并reload nginx。
    就这么简单。如果重写了源码，修改了Makefile比如添加依赖库之类，可以make clean重来一次。

cpp模板Makefile如下：

  2. PROJECT=demo.so
  3. SRC=$(shell find . -type f | egrep *.cpp$$)
  4. OBJ=$(patsubst %.cpp,%.o,$(SRC))
  6. ifndef NGINX_INSTALL_DIR
  7. NGINX_INSTALL_DIR=/usr/local/nginx
  8. endif
  10. CXX=g++ 
  11. CXXFLAGS+=-O3 -std=c++11 -fPIC -Wall -I$(NGINX_INSTALL_DIR)/include
  12. LDLIBS+=
  13. LDFLAGS+=-shared 
  15. all:$(PROJECT)
  17. $(PROJECT): $(OBJ)
  18.     $(CXX) $(CXXFLAGS) $(LDFLAGS)  -o $@ $^ $(LDLIBS)
  20. clean:
  21.     rm -f  $(OBJ) $(PROJECT)
  23. install:
  24.     test -d $(NGINX_INSTALL_DIR)/cpp || mkdir -p $(NGINX_INSTALL_DIR)/cpp
  25.     install $(PROJECT) $(NGINX_INSTALL_DIR)/cpp

常常需要自定义的是CXXFLAGS+=和LDLIBS+=，可以添加自己需要编译选项和库，比如要添加libfoo.so，它在/opt/lib，那么可以做如下：

  2. CXXFLAGS+=-L/opt/lib
  3. LDLIBS+=-lfoo

如果使用clang++，可以把CXX=g++改成CXX=clang++。

cpp模板源码是这样的：

  1. #include "servlet.hpp"
  2. namespace hi{
  3. class hello : public servlet {
  4.     public:
  6.         void handler(request& req, response& res) {
  7.             res.headers.find("Content-Type")->second = "text/plain;charset=UTF-8";
  8.             res.content = "hello,world";
  9.             res.status = 200;
  10.         }
  12.     };
  13. }
  15. extern "C" hi::servlet* create() {
  16.     return new hi::hello();
  17. }
  19. extern "C" void destroy(hi::servlet* p) {
  20.     delete p;
  21. }

要理解和用好cpp servlet类非常简单，只需熟悉STL即可。

sudo make install会把demo.so安装在hi-nginx安装目录下的cpp文件夹。编译出来的demo.so要能够正确运行，除了需要正确配置依赖外，还需要留意它的使用权限。因此，有时需要chmod +x。

原文: https://doc.hi-nginx.com/00/0004.html