Spring Bootでリクエストを送ったクライアントのIPアドレスを取得してみた

業務用のWEBアプリケーションを作成する際、アクセスログ等にIPアドレスを残しておきたい場合がある。

IPアドレスは、「-Djava.net.preferIPv4Stack=true」というJava起動時のVMオプションを付与しないと、IPv6形式で取得されてしまうので、IPv4形式で取得したい場合はこの指定が必要になる。

IPv4形式とIPv6形式の違いについては、以下のサイトに詳しく書かれている。
https://www.netassist.ne.jp/techblog/13678/

今回はログでなく、Spring BootのWEB画面用アプリで、リクエストを送ったクライアントのIPアドレスを取得し表示するサンプルプログラムと、IntelliJ IDEA上でのJava VMオプションの指定方法も含め共有する。

前提条件

以下の記事のSpring BootのWEB画面用アプリが作成済であること。

IntelliJ IDEA上でGradleを使ってWeb画面のSpring Bootプロジェクトを作成してみたSpring Bootのプロジェクトを新規作成を「IntelliJ IDEA」のメニューから実施しようとしたところ、無料の「Commun...

サンプルプログラム作成とその実行結果確認

今回は、Java VMオプションを指定する前に作成した、リクエストを送ったクライアントのIPアドレスを取得し画面に表示するプログラムを作成し、それを実行してみた。

今回作成したプログラム構成は以下の通り。

また、「DemoController.java」「index.html」の内容は以下の通り。

package com.example.demo;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;

@Controller
public class DemoController {

    @RequestMapping("/")
    public ModelAndView index(ModelAndView mav, HttpServletRequest request){
        //リクエストを送ったクライアントのIPアドレスを取得する
        String ipAddress = request.getRemoteAddr();
        mav.addObject("ipAddress", ipAddress);
        mav.setViewName("index");
        return mav;
    }
}

package com.example.demo;

import org.springframework.stereotype.Controller;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;

@Controller

public class DemoController {

@RequestMapping("/")

public ModelAndView index(ModelAndView mav, HttpServletRequest request){

//リクエストを送ったクライアントのIPアドレスを取得する

String ipAddress = request.getRemoteAddr();

mav.addObject("ipAddress", ipAddress);

mav.setViewName("index");

return mav;

}

<!DOCTYPE html>
<html lang="ja" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>index page</title>
</head>
<body>
    IPアドレスの取得結果：
    <p th:text="${ipAddress}">ここに取得したIPアドレスが設定されます</p>
</body>
</html>