将一些 JSON 文件加载到 Spring Boot 应用程序中的最佳方法

Question

我将要创建一个 Rest webservice 应用程序，我需要在应用程序启动时加载作为参数传递的文件夹中存在的所有 JSON 文件（在 application.yml aprii 中），以便稍后在 webservices 的方法中使用它们作为bean 列表（每个 JSON 文件对应一个 bean）。

进一步解释我的要求的示例：

应用程序.yml :

json.config.folder: /opt/my_application/json_configs

我的应用程序.java ：

package com.company;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

具有此结构的 JSON 文件：

    {  
   "key":"YYYYY",
   "operator_list":[  
        {  
           "name":"operator1",
           "configs":{  
               "id":"XXXXX1",
               "path":"xxxx2"
           }
        },
        {  
            "name":"operator2",
            "configs":{  
                "id":"XXXXX1",
                "passphrase":"xxxx2",
                "user_id":"XXXX3",
                "password":"XXXXX"
            }
        },
        {  
            "name":"operator3",
            "configs":{  
                "user_id":"XXXXX1"
            }
        }
    ]
    }

RESTAPI.java

@RestController
@RequestMapping("/my_app_url")
@PropertySource(value={"classpath:application.yml"})
public class RestAPI {
    //Some fields
    ....

    //Some methods
    ....

    //Method that return operator list of a given context (correspond to the field "key" of the json file)
    @RequestMapping("/getOperatorList")
    public List<Operator> getOperatorList(@RequestParam(value = "context", defaultValue = "YYYYY") String context) throws Exception{
        List<Operator> result = null;
        //Here, i need to loop the objects , that are supposed to be initialized during application startup 
        //(but i I do not know yet how to do it) with data from JSON files
        //to find the one that correspond to the context in parameter and return its operator list

        return result;
    }
}

ContextOperatorBean.java将包含先验的 JSON 文件信息：

package com.company.models;

import java.util.List;

public class ContextOperatorBean {
    String key;
    List<Operator> operator_list;

    public ContextOperatorBean() {
    }

    public ContextOperatorBean(String key, List<PaymentMethod> operator_list) {
        this.key = key;
        this.operator_list = operator_list;
    }

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }

    public List<Operator> getOperator_list() {
        return operator_list;
    }

    public void setOperator_list(List<Operator> operator_list) {
        this.operator_list = operator_list;
    }
}

另一个名为 Operator.java 的类包含所有操作员信息。

是否有一种方法可以在应用程序启动时初始化包含所有 JSON 文件信息的ContextOperatorBean对象列表，并在我的 Web 服务方法（RestAPI.java 类）中使用它们？

Answer 1

不知道以下幼稚的实现是否满足“最佳”的标准，但您可以创建一个处理此责任的新服务，例如：

@Service
public class OperatorsService {

    @Value("${json.config.folder}")
    String jsonConfigFolder;

    List<ContextOperatorBean> operators = new ArrayList<>();

    @PostConstruct
    public void init() throws IOException {
        ObjectMapper jsonMapper = new ObjectMapper();
        for (File jsonFile : getFilesInFolder(jsonConfigFolder)) {
            // deserialize contents of each file into an object of type
            ContextOperatorBean operator = jsonMapper.readValue(jsonFile, new TypeReference<List<ContextOperatorBean>>() {});
            operators.add(operator);
        }
    }

    public List<ContextOperatorBean> getMatchingOperators(String context) {
        return operators.stream().filter(operator -> checkIfMatches(operator, context)).collect(Collectors.toList());
    }

    private boolean checkIfMatches(ContextOperatorBean operator, String context) {
        // TODO implement
        return false;
    }

    private File[] getFilesInFolder(String path) {
        // TODO implement
        return null;
    }
}

注意：忽略了处理失败或意外情况以及一些实现细节。

然后@Autowire它在您的控制器中并调用getMatchingOperators()以仅过滤匹配的条目。