【云技术】Nacos 入门

Space Chars

已于 2024-01-22 14:21:19 修改

阅读量1.9k

点赞数 1

分类专栏：云技术文章标签： java spring boot docker

于 2022-02-10 12:06:12 首次发布

本文链接：https://blog.csdn.net/qq_40890233/article/details/122858041

版权

云技术专栏收录该内容

3 篇文章 0 订阅

订阅专栏

服务端（Server）

Docker（推荐）

nacos本身只是一个中间件，没有必要线下单独运行，线上部署后一样可以满足线下开发和线上部署

拉取镜像/命令（Pull Image/Command）

直接运行如下命令，如果未拉取镜像，docker会自动拉取
参数
–network：自定义网络
–network-alias：自定义网络别名，方便容器间访问和安全限制
-e MODE：配置nacos模式，nacos分为单机模式（standalone）和集群模式（cluster），默认cluster 集群模式

注意：
不绑定宿主机端口，是因为使用使用了网络别名，在配置nginx代理时，nginx直接访问的是容器的网络（nacos:8848），并非外网，这样访问更加安全，实现了网络隔离

docker run --name nacos \
--network customNet \
--network-alias nacos \
-e MODE=standalone  \
-d nacos/nacos-server

nginx代理（Nginx Proxy）

打开nginx的default.cnf，在server中添加如下转发
注意
/nacos是nacos的context-path值
nacos:8848：是因为上面的网络别名值未nacos，nacos开放端口是8848

location /nacos {
        proxy_pass   http://nacos:8848/nacos;
}

Resource Code

Git

客户端（Client）

Spring boot

nacos 在spring boot应用个人感觉不是很方便，建议搭建spring cloiud环境，方便后续应用升级和扩展

配置中心（Configuration Manager）

spring boot项目中多环境配置不能用spring.profiles.active、和nacos.config.group配置多环境，可以使用nacos.config.namespace命名空间来切换环境
因为在spring boot中，配置文件只通过dataid、group、namespace寻找文件，而group和dataId只能在@NacosPropertySource注解中配置才生效，所以启动jar包已参数形式传参不可行

依赖（Dependency）

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>${latest.version}</version>
</dependency>

配置（Configuration）

application.properties

nacos.config.server-addr=127.0.0.1:8848

ConfigApplication.java

@SpringBootApplication
@NacosPropertySource(dataId = "example", autoRefreshed = true)
public class ConfigApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosConfigApplication.class, args);
    }
}

ConfigController.java

在服务端配置中心配置：useLocalCache

@Controller
@RequestMapping("config")
public class ConfigController {

    @NacosValue(value = "${useLocalCache:false}", autoRefreshed = true)
    private boolean useLocalCache;

    @RequestMapping(value = "/get", method = GET)
    @ResponseBody
    public boolean get() {
        return useLocalCache;
    }
}

服务发现（Server Discovery）

在spring boot中nacos不支持自动注册，需要手动注册服务,可通过@PostConstruct注解自动注册

依赖（Dependency）

<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-discovery-spring-boot-starter</artifactId>
    <version>${latest.version}</version>
</dependency>

配置（Configuration）

application.properties

nacos.discovery.server-addr=127.0.0.1:8848

# server.ip=127.0.0.1
server.port=8081

DiscoveryController.java

@Controller
@RequestMapping("discovery")
public class DiscoveryController {

    @NacosInjected
    private NamingService namingService;
    
    /**
    * 获取服务
    **/
    @RequestMapping(value = "/get", method = GET)
    @ResponseBody
    public List<Instance> get(@RequestParam String serviceName) throws NacosException {
        return namingService.getAllInstances(serviceName);
    }
}

DiscoveryApplication.java

因为spring boot中nacos不能自动注册所以需要自己编写自动注册方法

@SpringBootApplication
public class ConfigApplication {
    
    @Value("${spring.application.name}")
    private String applicationName;
    	
    @Value("${server.port}")
    private int serverPort;
 
    @Value("${server.ip}")
    private String ip;
 
    @NacosInjected
    private NamingService namingService;

    public static void main(String[] args) {
        SpringApplication.run(NacosConfigApplication.class, args);
    }
 
    /**
     * 开机自动注册服务
     *
     * @throws NacosException
     */
    @PostConstruct
    public void registerInstance() throws NacosException {
        namingService.registerInstance(applicationName, ip, serverPort);
    }
}

Spring Cloud

版本依赖

注意
子jar包建议全部默认dependencies中的规定的版本，防止版本冲突

Spring Cloud Alibaba/Spring Cloud Nacos	Spring Cloud	Spring Boot
2.2.7.RELEASE	Hoxton.SR12	2.3.12.RELEASE
2021.1	2020.0.1	2.4.2
2.2.6.RELEASE	Hoxton.SR9	2.3.2.RELEASE
2.1.4.RELEASE	Greenwich.SR6	2.1.13.RELEASE
2.2.1.RELEASE	Hoxton.SR3	2.2.5.RELEASE
2.2.0.RELEASE	Hoxton.RELEASE	2.2.X.RELEASE
2.1.2.RELEASE	Greenwich	2.1.X.RELEASE
2.0.4.RELEASE(停止维护，建议升级)	Finchley	2.0.X.RELEASE
1.5.1.RELEASE(停止维护，建议升级)	Edgware	1.5.X.RELEASE

配置中心（Cofiguration Manager）

spring 2.4以后需要添加spring-cloud-bootstrap框架
配置文件需要写在bootstrap.properties或bootstrap.yml中
配置中心dataId匹配模式： ${prefix}-$ {spring.profiles.active}.${spring.cloud.nacos.config.file-extension}，prefix默认spring.application.name

依赖（Dependencies）

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/>
    </parent>

    <groupId>xxx.xx</groupId>
    <artifactId>xxx</artifactId>
    <version>1.0</version>
    <packaging>pom</packaging>

    <properties>
        <spring-cloud.version>2020.0.1</spring-cloud.version>
        <spring-cloud-alibaba.version>2021.1</spring-cloud-alibaba.version>

        <java.version>1.8</java.version>
    </properties>

    <dependencies>

        <!-- spring cloud bootstrap -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>

        <!-- nacos -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>


    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

配置（Configuration）

bootstrap.properties

spring.application.name=server-name

spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.namespace=3e428405-acdc-4498-9462-da285d200429
spring.cloud.nacos.config.group=PRODUCTION_GROUP
spring.cloud.nacos.config.file-extension=properties

服务发现（Server Discovery）

spring cloud中nacos是根据spring.application.name自动注册

依赖（Dependencies）

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/>
    </parent>

    <groupId>xxx.xx</groupId>
    <artifactId>xxx</artifactId>
    <version>1.0</version>
    <packaging>pom</packaging>

    <properties>
        <spring-cloud.version>2020.0.1</spring-cloud.version>
        <spring-cloud-alibaba.version>2021.1</spring-cloud-alibaba.version>

        <java.version>1.8</java.version>
    </properties>

    <dependencies>

        <!-- spring cloud bootstrap -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>

        <!-- nacos -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>


    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

配置（Configuration）

bootstrap.properties

spring cloud中默认采用spring.application.name作为服务名

spring.application.name=server-name

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

DescoveryApplication.java

@EnableDiscoveryClient：注解开启服务发现
@LoadBalanced：开启与 Ribbon 的集成

@SpringBootApplication
@EnableDiscoveryClient
public class DiscoveryApplication {
    @LoadBalanced
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

    public static void main(String[] args) {
        SpringApplication.run(DiscoveryApplication.class, args);
    }

    @RestController
    public class TestController {

        private final RestTemplate restTemplate;

        @Autowired
        public TestController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}

        @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
        public String echo(@PathVariable String str) {
            return restTemplate.getForObject("http://service-provider/echo/" + str, String.class);
        }
    }
}

跨服务调用

OpenFeign：服务调用，版本默认：3.0.1
LoadBalancer：负载均衡，版本默认：3.0.1
nacos：服务发现，版本默认：3.0.1

依赖（Dependencies）

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/>
    </parent>

    <groupId>xxx.xxx</groupId>
    <artifactId>xxxx</artifactId>
    <version>1.0</version>
    <packaging>pom</packaging>

    <properties>
        <spring-cloud.version>2020.0.1</spring-cloud.version>
        <spring-cloud-alibaba.version>2021.1</spring-cloud-alibaba.version>
    </properties>

    <dependencies>

        <!-- spring cloud -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-loadbalancer</artifactId>
        </dependency>

        <!-- nacos -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>com.netflix.ribbon</groupId>
                    <artifactId>ribbon</artifactId>
                </exclusion>
            </exclusions>
        </dependency>


    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

配置（Configuration）

ServiceInvokeApplication.java

如果@FeignClicent注解标注类没有写在Application启动类的同级或子级目录下则需要通过basePackages指定@FeignClicent注解标注类的包名，否则@FeignClicen注解t标注类不能自动注入到spring IOC中

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
//@EnableFeignClients(basePackages={"xxxxxx.services.proivder"})
public class ServiceInvokeApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServiceInvokeApplication.class, args);
    }

}

ServiceProvider.java

如果目标服务存在context-path，则需要通过path指定，否则会出现404
name属性指定服务名称

@FeignClient(name = "ServiceProvider",path = "/api")
public interface ServiceProvider {

    @GetMapping("/hello")
    String getHello();
}

ServiceInvokeController.java

注入ServiceProvider

@RestController
public class ServiceInvokeController {

    @Autowired
    private ServiceProvider serviceProvider;

    @GetMapping("/get")
    public String get() {
        return serviceProvider.getHello();
    }
}

ServiceProviderApplication.java

@SpringBootApplication
@EnableDiscoveryClient
public class ServiceProviderApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServiceProviderApplication.class, args);
    }
}

ServiceProviderController.java

@RefreshScope开启自动刷新
在nacos配置中心配置text值

@RestController
@RefreshScope
public class ServiceInvokeController {
    
    @Value("${text:11}")
    private String text;

    @GetMapping("/hello")
    public String getHello() {
        return text;
    }
}

FAQ

No Feign Client for loadBalancing defined.

将spring-cloud-starter-openfeign，spring-cloud-starter-bootstrap中自定义版本删除，使用spring-cloud-dependencies中规定的默认版本即可，最好不要自定义版本
引入spring-cloud-loadbalancer依赖（使用默认版本）

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-loadbalancer</artifactId>
</dependency>