【NestJS】获取客户端IP完美解决方法

根据以往传统后台经验，获取api请求的客户端ip应该很简单才对，直接 Request.IP 不就可以了么，然后根据这个思路找一下 nestjs里面的request对象，还真有 .ip(get) 的方法，但高兴得有点早，使用起来发现获取到的 ip 地址不是null 就是 127.0.0.1

后面还是找下现成的包，发现可以用 request-ip 这个包来实现真实ip的获取

安装request-ip

npm install --save request-ip

npm install --save-dev @types/request-ip

封装装饰器，方便控制器里面直接使用

import { createParamDecorator, ExecutionContext } from '@nestjs/common'

import * as requestIp from 'request-ip'

export const IpAddress = createParamDecorator(
    (data: unknown, ctx: ExecutionContext) => {
        const req = ctx.switchToHttp().getRequest()
        if (req.clientIp)
            return req.clientIp;
        return requestIp.getClientIp(req);
    })

这里面得特别注意下上下文 ctx的设置，否则根据网上的资料直接copy过来的可能为null

控制器获取ip

@Get('getClientIp')
  getClientIp(@IpAddress() clinetIp: string) {
    return new ApiResultData(true, clinetIp, { ip: clinetIp })
  }

其他地方如全局异常获取ip

import * as requestIp from 'request-ip';


export class AllExceptionsFilter implements ExceptionFilter {
    catch(exception: unknown, host: ArgumentsHost) {
        //...其他逻辑

        const clientIp = requestIp.getClientIp(request)

        //...其他逻辑
    }
}