Shulou(Shulou.com)06/01 Report--

This article introduces the relevant knowledge of "how to internationalize Springboot+AOP return data prompts". In the operation of actual cases, many people will encounter such a dilemma, so let the editor lead you to learn how to deal with these situations. I hope you can read it carefully and be able to achieve something!

Text

First, take a look at the project directory structure of this example teaching:

(of course, we also have to build the i18n folder and three properties files in resource, but don't worry about that Resource Bundle, this is automatically generated in yml plus the corresponding configuration items. If you don't know, just keep looking at the teaching.)

Start typing (CV) the code:

Pom.xml dependencies:

Org.springframework.boot spring-boot-starter-web com.alibaba fastjson 1.2.68 org.apache.commons commons-lang3 3.9 org.projectlombok lombok 1.18.10 Provided org.springframework.boot spring-boot-starter-aop org.springframework.boot spring-boot-starter-test test

Enumeration of return codes

CodeEnum.java

/ * * @ author JCccc * / public enum CodeEnum {SUCCESS (1000, "request succeeded"), FAIL (2000, "request failed"); public final int code; public final String msg; public Integer getCode () {return this.code;} CodeEnum (int code, String msg) {this.code = code; this.msg = msg } public String getMsg () {return this.msg;}}

Simple encapsulation of returned data

ResultData.java

Import com.test.myi18n.enums.CodeEnum;import lombok.Data; / * * @ author JCccc * / @ Datapublic class ResultData {private Integer code; private String message; private T data; public ResultData (int code, String message) {this.code = code; this.message = message;} public static ResultData success (CodeEnum codeEnum) {return new ResultData (codeEnum.code, codeEnum.msg) } public static ResultData success (String msg) {return new ResultData (CodeEnum.SUCCESS.getCode (), msg);}}

Simple method encapsulation of Locale and MessageSource

LocaleMessage.java

Import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.MessageSource;import org.springframework.context.i18n.LocaleContextHolder;import org.springframework.stereotype.Component; import java.util.Locale; / * * @ author JCccc * / @ Componentpublic class LocaleMessage {@ Autowired private MessageSource messageSource; public String getMessage (String code) {return this.getMessage (code,new Object [] {}) } public String getMessage (String code,String defaultMessage) {return this.getMessage (code,null,defaultMessage);} public String getMessage (String code,String defaultMessage,Locale locale) {return this.getMessage (code,null,defaultMessage,locale);} public String getMessage (String code,Locale locale) {return this.getMessage (code,null, ", locale);} public String getMessage (String code,Object [] args) {return this.getMessage (code,args,") } public String getMessage (String code,Object [] args,Locale locale) {return this.getMessage (code,args, ", locale);} public String getMessage (String code,Object [] args,String defaultMessage) {return this.getMessage (code,args, defaultMessage,LocaleContextHolder.getLocale ());} public String getMessage (String code,Object [] args,String defaultMessage,Locale locale) {return messageSource.getMessage (code,args, defaultMessage,locale);}}

I18n language conversion tool class

I18nUtils.java

Import java.util.Locale;import com.test.myi18n.message.LocaleMessage;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Component; @ Componentpublic class I18nUtils {@ Autowired private LocaleMessage localeMessage; / * get key * * @ param key * @ return * / public String getKey (String key) {String name = localeMessage.getMessage (key); return name } / * get key * * @ param key * @ param local * @ return * / public String getKey (String key, Locale local) {String name = localeMessage.getMessage (key, local); return name;}}

Next is a key part of our conversion. Aop intercepts the data returned by the controller API:

LanguageAspect.java

Import lombok.AllArgsConstructor;import org.apache.commons.lang3.StringUtils;import org.aspectj.lang.JoinPoint;import org.aspectj.lang.annotation.AfterReturning;import org.aspectj.lang.annotation.Aspect;import org.aspectj.lang.annotation.Pointcut;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;import org.springframework.stereotype.Component;import org.springframework.web.context.request.RequestAttributes;import org.springframework.web.context.request.RequestContextHolder; import javax.servlet.http.HttpServletRequest Import java.util.*; / * * @ author JCccc * / @ Aspect@Component@AllArgsConstructor@ConditionalOnProperty (prefix = "lang", name = "open", havingValue = "true") public class LanguageAspect {@ Autowired I18nUtils i18n Utils; @ Pointcut ("execution (* com.test.myi18n.controller.*.* (..))") Public void annotationLangCut () {} / * intercepts the result returned by the controller layer, and modifies the msg field * * @ param point * @ param obj * / @ AfterReturning (pointcut = "annotationLangCut ()", returning = "obj") public void around (JoinPoint point, Object obj) {Object resultObject = obj; try {RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes () / / get the information of HttpServletRequest from RequestAttributes HttpServletRequest request = (HttpServletRequest) requestAttributes.resolveReference (RequestAttributes.REFERENCE_REQUEST); String langFlag = request.getHeader ("lang"); if (null! = langFlag) {ResultData r = (ResultData) obj; String msg = r.getMessage () .trim () If (StringUtils.isNotEmpty (msg)) {if ("CN" .equals (langFlag)) {Locale locale = Locale.CHINA; msg = i18nUtils.getKey (msg, locale);} else if ("EN" .equals (langFlag)) {Locale locale = Locale.US Msg = i18nUtils.getKey (msg, locale);} else {msg = i18nUtils.getKey (msg);}} r.setMessage (msg);}} catch (Exception e) {e.printStackTrace () / / return the original value obj = resultObject;}

Simple interpretation of the code:

1. The address of the pointcut control on annotationLangCut needs to be changed to the folder path you want to control.

2. @ ConditionalOnProperty annotation. Read the configuration items that begin with lang in yml. Key is open and value is true.

This aop interception will take effect only if it is for true.

3. String langFlag = request.getHeader ("lang")

You can see from this sentence that what I have adopted in this article is to ask the interface side (front end) to pass in the language flag that needs to be used in header. For example, the introduction of EN (English) means that the prompt needs to be converted into English.

According to the actual situation of your project, you can read from yml, database, redis and so on.

4. ResultData r = (ResultData) obj

String msg = r.getMessage () .trim ()

These two lines of code are in order to get the message prompt in the intercepted obj. If the returned data of your project is not the ResultData used in this article, you need to make your own magic adjustment.

Finally, there are three mess properties documents:

Mess.properties

Custom return = Hello, if the article is useful to you, please follow + favorites + comments

According to the interception method of aop in this article, this file will first detect the current language threshold value, and if it cannot be detected, h will arrive.

Look in the mess.properties file.

Mess_en_US.properties

Request success = success

Request failed = fail

Mess_zh_CN.properties

Successful request = successful request

Request failed = request failed

Success= request succeeded

Fail= request failed

Finally, write a test interface to demonstrate the effect:

@ GetMapping ("test") public ResultData test (@ RequestParam int testNum) {if (1==testNum) {return ResultData.success (CodeEnum.SUCCESS);} if (2==testNum) {return ResultData.success (CodeEnum.FAIL);} if (3==testNum) {return ResultData.success ("custom return words");} return ResultData.success (CodeEnum.SUCCESS) }

Invoke the test:

This is the end of the content of "how to internationalize the Springboot+AOP return data prompt". Thank you for your reading. If you want to know more about the industry, you can follow the website, the editor will output more high-quality practical articles for you!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.