No message found under code 'male' for locale 'ja' を解決したいです。

Question

前提

「Spring 解体新書」という書籍で学習しています。
メッセージを解決できない例外でエラーが出ています。
ソースコードに問題はなさそうです。
getMessageでmessages.propertiesの値を取れるはずですがどこに問題があるかが不明です。

実現したいこと

ユーザー登録画面を表示できるようにしたいです。

発生している問題・エラーメッセージ

There was an unexpected error (type=Internal Server Error, status=500).
No message found under code 'male' for locale 'ja'.
org.springframework.context.NoSuchMessageException: No message found under code 'male' for locale 'ja'.
	at org.springframework.context.support.DelegatingMessageSource.getMessage(DelegatingMessageSource.java:76)
	at com.example.application.service.UserApplicationService.getGenderMap(UserApplicationService.java:20)
	at com.example.controller.SignupController.getSignup(SignupController.java:44)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:197)
	at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:141)

該当のソースコード

package com.example.application.service;

import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.stereotype.Service;

@Service
public class UserApplicationService {

	@Autowired
	private MessageSource messageSource;
	
//	性別のMAPを生成する
	public Map<String,Integer>getGenderMap(Locale locale){
		Map<String,Integer>genderMap = new LinkedHashMap<>();
		String male = messageSource.getMessage("male",null,locale);
		String female = messageSource.getMessage("female", null,locale);
		genderMap.put(male, 1);
		genderMap.put(female, 2);
		return genderMap;
	}
}

package com.example.controller;

import java.util.Locale;
import java.util.Map;

import org.modelmapper.ModelMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import com.example.application.service.UserApplicationService;
import com.example.domain.user.model.MUser;
import com.example.domain.user.service.UserService;
import com.example.form.GroupOrder;
import com.example.form.SignupForm;

import lombok.extern.slf4j.Slf4j;

@Controller
@RequestMapping("/user")
@Slf4j
public class SignupController {
	
	@Autowired
	private UserApplicationService userApplicationService;
	
	@Autowired
	private UserService userService;
	
	@Autowired
	private ModelMapper modelMapper;
	
//	ユーザー登録画面を表示
	@GetMapping("/signup")
	public String getSignup(Model model, Locale locale, @ModelAttribute SignupForm form) {
		
		//性別を取得
		Map<String,Integer> genderMap = userApplicationService.getGenderMap(locale);
		model.addAttribute("genderMap", genderMap);
		
		//ユーザー登録画面に遷移
		return "user/signup";
	}
	
	//ユーザー登録処理
	@PostMapping("/signup")
	public String postSignup(Model model, Locale locale, @ModelAttribute @Validated(GroupOrder.class) SignupForm form, BindingResult bindingResult) {

		//入力チェック結果
		if(bindingResult.hasErrors()) {
			//NG:ユーザー登録画面に戻ります。
			return getSignup(model, locale, form);
		}

		log.info(form.toString());
		
		//formをMUserクラスに変更
		MUser user = modelMapper.map(form, MUser.class);
		
		//ユーザー登録
		userService.signup(user);
		
		//ログイン画面にリダイレクト
		return  "redirect:/login";
	}
}

package com.example.form;

import java.util.Date;

import javax.validation.constraints.Email;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;

import org.hibernate.validator.constraints.Length;
import org.springframework.format.annotation.DateTimeFormat;

import lombok.Data;

@Data
public class SignupForm{
	
        @NotBlank(groups = ValidGroup1.class)
        @Email(groups = ValidGroup2.class)
        private String userId;
        
        @NotBlank(groups = ValidGroup1.class)
        @Length(min = 4, max = 100, groups = ValidGroup2.class)
        @Pattern(regexp = "^[a-zA-Z0-9]+$", groups = ValidGroup2.class)
        private String password;
        
        @NotBlank(groups = ValidGroup1.class)
        private String userName;
        
        @DateTimeFormat(pattern = "yyyy/MM/dd")
        @NotNull(groups = ValidGroup1.class)
        private Date birthday;
        
        @Min(value = 20, groups = ValidGroup2.class)
        @Max(value = 100, groups = ValidGroup2.class)
        private Integer age;
        
        @NotNull(groups = ValidGroup1.class)
        private Integer gender;
}

user.signup.title=ユーザー登録
user.signup.btn=ユーザー登録
userId=ユーザーID
password=パスワード
userName=ユーザー名
birthday=誕生日
age=年齢
male=男性
female=女性
gender=性別

試したこと

下記の確認

• ソースコード差分
• getMessageメソッドの使用方法
• propertiesファイルのファイル名

補足情報（FW/ツールのバージョンなど）

Spring Boot 2.4.1

Comments

[jimbe]

> messaegs.properties

このファイル名なんでしょうか?

[Mason]

getMessageでキーにした値をこのファイルにある値でとってくるためのファイルです。
ファイル名間違えていたので修正しました。

[jimbe]

単に質問への書き間違いということで良いでしょうか。

他に気になるのは、例外のメッセージは "age" が無いと言っているのに、行番号の該当コードは "male" を得ようとしていることです。ご提示のコードは例外が発生したコードそのままでしょうか。
また、messages.properties は示されていますが messages_ja.properties の有無は言及されていません。もしあれば当然優先されると思いますが、如何でしょう。

Answer 1

application.properties

に次の行を登録したら，なぜかうまくいきました。理由は全くわかりません。

user.signup.title=ユーザ登録

Answer 2

回答

前提

WebでもアプリでもSpringでも何でも国際化やローカライズはある程度以上の規模になると必要です。何か文字列を表示させる場合に、ハードコードしてしまうとそれができなくなってしまうので、ほとんどのシステムではそれらを意識した設計が可能になっています。Javaでは言語(標準ライブラリ)でそれらの仕組みを昔から持っており、ResourceBundleというものが使用されてきました。Springのorg.springframework.context.MessageSourceもその辺のクラスに該当します。

原因

今回クライアント側は/signupを日本語(ja)最優先でGETしてきたので、MessageSourceを使ってLocale.JAPANESEでメッセージを取得しようとします。しかし、リソースにmessages_ja.propertiesファイルがないので、例外が発生しているのではないかと思います。

対策

messages_ja.propertiesをmessages.propertiesと同じディレクトリに同じ内容で作成すると動作が変わると思います。

ドキュメントについては↓の辺が該当しますが、あまり明快ではありません。
https://docs.spring.io/spring-boot/docs/2.4.1/reference/html/spring-boot-features.html#boot-features-internationalization

おまけ

確認用に用意したコードを置いておきます。

環境

String Boot 2.7.7
Java 11

ソースディレクトリ構造

├── main
│   ├── java
│   │   └── com
│   │       └── example
│   │           └── demo
│   │               └── MessageTestApplication.java
│   └── resources
│       ├── application.properties
│       ├── messages.properties
│       ├── messages_en.properties
│       └── messages_ja.properties
└── test
    └── java
        └── com
            └── example
                └── demo
                    └── MessageTestApplicationTests.java

ファイルの内容

※テストは未作成

MessageTestApplication.java

package com.example.demo;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.MessageSource;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController
public class MessageTestApplication {
	@Autowired
	MessageSource messageSource;
	@GetMapping ("/")
	public Map<String, String> home() {
		var map = new HashMap<String, String>();
		Locale[] locales = new Locale[] {Locale.JAPANESE, Locale.ENGLISH, Locale.CHINESE};
		for (var locale: locales) {
			map.put(locale.getDisplayName(), messageSource.getMessage("hello", null, locale));
		}
		return map;
	}
	public static void main(String[] args) {
		SpringApplication.run(MessageTestApplication.class, args);
	}
}

application.properties

spring.messages.basename=messages
spring.messages.encoding=UTF-8

messages.properties

hello=hellodefault

messages_en.properties

hello=hello

messages_ja.properties

hello=こんにちは

実行結果

$ wget -q -O - 'http://localhost:8080/';echo
{"English":"hello","Chinese":"hello","Japanese":"こんにちは"}
$ 

最後に

最初は大変だと思いますが、いきなりsignupを含んだコードで質問せず、現象を起こすために最小限の確認用コード一式を作成してから質問してください。

Comments

[Mason]

原因の内容を理解しました。優先順位がある中で、必要なファイルがなくてエラーになってるのでは？とのことですね。
ご指摘いただいたとおり、修正してみましたが再度同じエラーになります。
エラーメッセージが「No message found under code 'male' for locale 'ja_JP'.」となったくらいです。
しかし、書籍と同じバージョンで同じように進めていく中で他に原因はありますでしょうか？
messages_ja.propertiesファイルも書籍には記載がありませんでした。

[dameo]

書籍は持っていません。何か内容に文句があるなら出版社か著者に直接問い合わせてください。
それよりも原因の内容を理解したのであれば、あとはもう自分で調べられると思いますよ。
「再度同じエラーになる」とか、理解してないとしか思えません。
Springは(他もそうだけど)それほど丁寧なマニュアルがないので、手探りや書籍・解説記事を参考にしたソース解析が必要な所謂オープンソースなソフトです。これだけ情報があるのに自分で調べられないなら、素直に諦めてもいいかもしれません。
解説記事としてはこの辺でしょうか・・・
https://reflectoring.io/spring-boot-internationalization/
https://www.javatpoint.com/restful-web-services-internationalization
ご参考までに。

Answer 3

https://start.spring.io/#!type=gradle-project-kotlin&language=kotlin&platformVersion=2.7.7&packaging=jar&jvmVersion=11&groupId=com.example&artifactId=demo&name=demo&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.demo

補足情報（FW/ツールのバージョンなど）
Spring Boot 2.4.1

-  id("org.springframework.boot") version "2.7.7"  
+  id("org.springframework.boot") version "2.4.1"

$ tree
.
├── src
│     ├── main
│     │     ├── kotlin
│     │     └── resources
│     │         ├── messages.properties ... あなたのものをコピペ
│     └── test
│         ├── java
│         │     └── com
│         │         └── example
│         │             └── demo
│         │                 └── MsgTest.java

package com.example.demo;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.MessageSource;
import java.util.Locale;

@SpringBootTest
public class MsgTest {

  @Autowired
  private MessageSource _messageSource;

  @Test
  public void hogege() throws Exception {
    System.out.println("xxx : " + this);
    System.out.println("_messageSource : " + _messageSource);

    {
      String msg = _messageSource.getMessage("age", new Object[]{}, Locale.getDefault());
      System.out.println("msg : " + msg);
    }

    {
      String msg = _messageSource.getMessage("age", new Object[]{}, Locale.JAPAN);
      System.out.println("msg : " + msg);
    }

    {
      String msg = _messageSource.getMessage("age", new Object[]{}, new Locale("ja"));
      System.out.println("msg : " + msg);
    }

    {
      String msg = _messageSource.getMessage("age", null, new Locale("ja"));
      System.out.println("msg : " + msg);
    }
  }
}

結果。別に問題なさげ。

_messageSource : org.springframework.context.support.ResourceBundleMessageSource: basenames=[messages]
msg : 年齢
msg : 年齢
msg : 年齢
msg : 年齢