<!-- review: finished -->

<a id="stream-geo"></a>

# Geo

该模块根据客户端 IP 地址创建具有不同值的变量。

<a id="configuration-example-58"></a>

## 配置示例

```nginx
geo $geo {
    default        0;

    127.0.0.1      2;
    192.168.1.0/24 1;
    10.1.0.0/16    1;

    ::1            2;
    2001:0db8::/32 1;
}
```

<a id="directives-67"></a>

## 指令

<a id="index-0"></a>

<a id="s-geo"></a>

### geo

| [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile)   | `geo` [$address] $variable { ... }   |
|--------------------------------------------------------------------------------------|--------------------------------------|
| 默认                                                                                   | —                                    |
| [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile)  | stream                               |

描述指定变量的值如何依赖于客户端 IP 地址。默认情况下,地址取自 [$remote_addr](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#v-remote-addr) 变量,但也可以取自其他变量,例如:

```nginx
geo $arg_remote_addr $geo {
    ...;
}
```

#### NOTE
因为变量仅在使用时才被评估,所以即使存在大量声明的 `geo` 变量,也不会对连接处理造成额外开销。

如果变量的值不是一个有效的 IP 地址,则使用 "255.255.255.255" 地址。

地址可以指定为 CIDR 表示法中的前缀(包括单个地址)或作为范围。

还支持以下特殊参数:

| `delete`   | 删除指定的网络                                                                                                     |
|------------|-------------------------------------------------------------------------------------------------------------|
| `default`  | 当客户端地址不匹配任何指定地址时,赋给变量的值。当地址以 CIDR 表示法指定时,可以用 "`0.0.0.0/0`" 和 "`:/0`" 代替 `default`。当未指定 `default` 时,默认值为空字符串 |
| `include`  | 包含一个包含地址和值的文件。可以有多个包含                                                                                       |
| `ranges`   | 指示地址以范围形式指定。此参数应放在首位。为了加快 geo 基础的加载,地址应按升序排列                                                                |
| `volatile` | 指示该变量不可缓存                                                                                                   |

示例:

```nginx
geo $country {
    default        ZZ;
    include        conf/geo.conf;
    delete         127.0.0.0/16;

    127.0.0.0/24   US;
    127.0.0.1/32   RU;
    10.1.0.0/16    RU;
    192.168.1.0/24 UK;
}
```

`conf/geo.conf` 文件可能包含以下行:

```console
10.2.0.0/16    RU;
192.168.2.0/24 RU;
```

使用最具体匹配的值。例如,对于 `127.0.0.1` 地址,将选择值 `RU`,而不是 `US`。

使用范围的示例:

```nginx
geo $country {
    ranges;
    default                   ZZ;
    127.0.0.0-127.0.0.0       US;
    127.0.0.1-127.0.0.1       RU;
    127.0.0.2-127.0.0.255     US;
    10.1.0.0-10.1.255.255     RU;
    192.168.1.0-192.168.1.255 UK;
}
```