如何以源码形式运行Nacos Server

Posted 2021-03-29 JAVA架构日记

官方标准运行方式

下载解压可运行包

curl -O https://github.com/alibaba/nacos/releases/download/1.3.2/nacos-server-1.3.2.tar.gz
tar -zxvf nacos-server-1.3.2.tar.gz
cd nacos/bin

执行运行

# Linux/Unix/Mac 启动命令(standalone代表着单机模式运行，非集群模式):

sh startup.sh -m standalone

# 如果您使用的是ubuntu系统，或者运行脚本报错提示[[符号找不到，可尝试如下运行：

bash startup.sh -m standalone

# Windows 启动命令（或者双击startup.cmd运行文件）

cmd startup.cmd

为什么要源码化运行

1. 方便开发过程使用

如果从 Spring Cloud Netflix 体系迁移到 Spring Cloud Alibaba 技术体系，明显的感受是整个体系得到简化。Nacos 承担整个 Spring Cloud 的服务发现、配置管理部分的实现。是整个开发过程中强依赖，启动微服务业务要去检查 Nacos Server 是否已经启动，解压安装的方式变的非常不便。

如果把 Nacos Server 作为整个微服务框架的一部分直接 Main 启动，是不是更加方便便利？

2. UI 个性定制化

• 若以解压运行方式，修改 UI 几乎不可能。可以下载 Nacos 源码继续修改 然后重新打包运行。非常的不方便

git clone https://github.com/alibaba/nacos.git

cd nacos/

mvn -Prelease-nacos -Dmaven.test.skip=true clean install -U
ls -al distribution/target/

// change the $version to your actual path
cd distribution/target/nacos-server-$version/nacos/bin

• 若以源码方式运行，可以试试的调整 UI 然后 build 看到效果。

3. 保证 Server & Client 保持一致

• pig 作为微服务开源项目，更新迭代速度非常快。每个版本依赖的 Nacos Client 版本都可能发生变化，这就意味着对应的 Nacos Server 版本也要对应升级，这需要用户自行下载升级成本很高。

• Nacos 具有良好小版本向下兼容性，但是大版本功能变化挺大，比如 1.2 、1.3 权限的变更。所以建议大家在实际开发过程中保持版本一致。

• 若以源码运行的方式，可以很好的解决此问题。

如何实现

1. 下载 Nacos 源码

只需保留 nacos console 模块，其他模块均可删除

   

2.  Nacos 源码结构说明

├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── alibaba
    │   │           └── nacos
    │   │               ├── Nacos.java  # main 启动类
    │   │               └── console    # 控制台相关源码
    │   └── resources
    │       ├── application.properties  # nacos 配置文件
    │       └── static    # 静态页面目录
    └── test    # 单元测试部分

3. 修改 Nacos.java 类

• 主要在 main 方法中增加 两个参数，是否是单机启动 & 是否关闭权限校验

@SpringBootApplication(scanBasePackages = "com.alibaba.nacos")
@ServletComponentScan
@EnableScheduling
public class Nacos {

    public static void main(String[] args) {
        # 通过环境变量的形式 设置 单机启动
      System.setProperty(ConfigConstants.STANDALONE_MODE, "true");

        # 通过环境变量的形式 设置 关闭权限校验
      System.setProperty(ConfigConstants.AUTH_ENABLED, "false");
        SpringApplication.run(Nacos.class, args);
    }
}

4. 修改 console/pom.xml

• 由于不在使用 nacos bom 管理，需要给所有依赖坐标增加版本号

• 由于 nacos-config /nacos-naming 等包没有上传至中央参考 无法下载到，groupId 变更为 com.pig4cloud.nacos 即可下载

• 变更后参考如下

<dependency>
  <groupId>com.pig4cloud.nacos</groupId>
  <artifactId>nacos-config</artifactId>
  <version>1.3.2</version>
</dependency>
<dependency>
  <groupId>org.apache.tomcat.embed</groupId>
  <artifactId>tomcat-embed-jasper</artifactId>
  <version>7.0.59</version>
</dependency>
<dependency>
  <groupId>com.pig4cloud.nacos</groupId>
  <artifactId>nacos-naming</artifactId>
  <version>1.3.2</version>
</dependency>
...

总结

1. 以上修改后源码参考： https://gitee.com/log4j/pig ^[1]
2. 是否以源码形式运行，此问题仁者见仁智者见智 根据你们实际情况来。

参考资料

[1]

https://gitee.com/log4j/pig: https://gitee.com/log4j/pig/blob/master/pig-register/pom.xml