SpringアプリケーションでCSVを介してセットアップデータを外部化する

投稿日: 2019-10-19 2022-11-02
タグ: Spring Data

1. 概要

この記事では、アプリケーションのセットアップデータをハードコーディングする代わりに、CSVファイルを使用して外部化します。

このセットアッププロセスは、主に新しいシステムでの新しいデータのセットアップに関係しています。

2. CSVライブラリ

まず、CSVを操作するための簡単なライブラリJacksonCSV拡張機能を紹介します。

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-csv</artifactId>       
    <version>2.5.3</version>
</dependency>

もちろん、JavaエコシステムでCSVを操作するために利用できるライブラリは多数あります。

ここでJacksonを使用する理由は、Jacksonがアプリケーションですでに使用されている可能性が高く、データを読み取るために必要な処理がかなり単純であるためです。

3. セットアップデータ

プロジェクトが異なれば、異なるデータを設定する必要があります。

このチュートリアルでは、ユーザーデータを設定します–基本的に少数のデフォルトユーザーでシステムを準備します。

ユーザーを含む単純なCSVファイルは次のとおりです。

id,username,password,accessToken
1,john,123,token
2,tom,456,test

ファイルの最初の行がヘッダー行であることに注意してください–データの各行のフィールドの名前をリストします。

3. CSVデータローダー

まず、CSVファイルからワーキングメモリにデータを読み取るための簡単なデータローダーを作成することから始めましょう。

3.1. オブジェクトのリストをロードする

loadObjectList（）機能を実装して、ファイルから特定のObjectの完全にパラメーター化されたリストをロードします。

public <T> List<T> loadObjectList(Class<T> type, String fileName) {
    try {
        CsvSchema bootstrapSchema = CsvSchema.emptySchema().withHeader();
        CsvMapper mapper = new CsvMapper();
        File file = new ClassPathResource(fileName).getFile();
        MappingIterator<T> readValues = 
          mapper.reader(type).with(bootstrapSchema).readValues(file);
        return readValues.readAll();
    } catch (Exception e) {
        logger.error("Error occurred while loading object list from file " + fileName, e);
        return Collections.emptyList();
    }
}

ノート：

最初の「ヘッダー」行に基づいてCSVSchemaを作成しました。
実装は、あらゆるタイプのオブジェクトを処理するのに十分な汎用性があります。
エラーが発生した場合は、空のリストが返されます。

3.2. 多対多の関係を処理する

ネストされたオブジェクトは、Jackson CSVでは十分にサポートされていません。多対多の関係をロードするには、間接的な方法を使用する必要があります。

これらのは単純な結合テーブルと同様に表現します。したがって、当然、配列のリストとしてディスクからロードします。

public List<String[]> loadManyToManyRelationship(String fileName) {
    try {
        CsvMapper mapper = new CsvMapper();
        CsvSchema bootstrapSchema = CsvSchema.emptySchema().withSkipFirstDataRow(true);
        mapper.enable(CsvParser.Feature.WRAP_AS_ARRAY);
        File file = new ClassPathResource(fileName).getFile();
        MappingIterator<String[]> readValues = 
          mapper.reader(String[].class).with(bootstrapSchema).readValues(file);
        return readValues.readAll();
    } catch (Exception e) {
        logger.error(
          "Error occurred while loading many to many relationship from file = " + fileName, e);
        return Collections.emptyList();
    }
}

これらの関係の1つは次のとおりです– 役割<->特権 –単純なCSVファイルで表されます。

role,privilege
ROLE_ADMIN,ADMIN_READ_PRIVILEGE
ROLE_ADMIN,ADMIN_WRITE_PRIVILEGE
ROLE_SUPER_USER,POST_UNLIMITED_PRIVILEGE
ROLE_USER,POST_LIMITED_PRIVILEGE

この実装ではヘッダーを実際には必要ないため、ヘッダーを無視していることに注意してください。

4. セットアップデータ

次に、単純なセットアップ beanを使用して、CSVファイルから特権、役割、およびユーザーをセットアップするすべての作業を実行します。

@Component
public class Setup {
    ...
    
    @PostConstruct
    private void setupData() {
        setupRolesAndPrivileges();
        setupUsers();
    }
    
    ...
}

4.1. 役割と特権を設定する

まず、ロールと特権をディスクから作業メモリーにロードし、セットアッププロセスの一部としてそれらを永続化します。

public List<Privilege> getPrivileges() {
    return csvDataLoader.loadObjectList(Privilege.class, PRIVILEGES_FILE);
}

public List<Role> getRoles() {
    List<Privilege> allPrivileges = getPrivileges();
    List<Role> roles = csvDataLoader.loadObjectList(Role.class, ROLES_FILE);
    List<String[]> rolesPrivileges = csvDataLoader.
      loadManyToManyRelationship(SetupData.ROLES_PRIVILEGES_FILE);

    for (String[] rolePrivilege : rolesPrivileges) {
        Role role = findRoleByName(roles, rolePrivilege[0]);
        Set<Privilege> privileges = role.getPrivileges();
        if (privileges == null) {
            privileges = new HashSet<Privilege>();
        }
        privileges.add(findPrivilegeByName(allPrivileges, rolePrivilege[1]));
        role.setPrivileges(privileges);
    }
    return roles;
}

private Role findRoleByName(List<Role> roles, String roleName) {
    return roles.stream().
      filter(item -> item.getName().equals(roleName)).findFirst().get();
}

private Privilege findPrivilegeByName(List<Privilege> allPrivileges, String privilegeName) {
    return allPrivileges.stream().
      filter(item -> item.getName().equals(privilegeName)).findFirst().get();
}

次に、ここで永続化作業を行います。

private void setupRolesAndPrivileges() {
    List<Privilege> privileges = setupData.getPrivileges();
    for (Privilege privilege : privileges) {
        setupService.setupPrivilege(privilege);
    }

    List<Role> roles = setupData.getRoles();
    for (Role role : roles) {
        setupService.setupRole(role);
    }
}

そして、これがSetupServiceです。

public void setupPrivilege(Privilege privilege) {
    if (privilegeRepository.findByName(privilege.getName()) == null) {
        privilegeRepository.save(privilege);
    }
}

public void setupRole(Role role) {
    if (roleRepository.findByName(role.getName()) == null) { 
        Set<Privilege> privileges = role.getPrivileges(); 
        Set<Privilege> persistedPrivileges = new HashSet<Privilege>();
        for (Privilege privilege : privileges) { 
            persistedPrivileges.add(privilegeRepository.findByName(privilege.getName())); 
        } 
        role.setPrivileges(persistedPrivileges); 
        roleRepository.save(role); }
}

ロールと特権の両方を作業メモリーにロードした後、それらの関係を1つずつロードする方法に注意してください。

4.2. 初期ユーザーの設定

次へ– users をメモリにロードして、永続化します。

public List<User> getUsers() {
    List<Role> allRoles = getRoles();
    List<User> users = csvDataLoader.loadObjectList(User.class, SetupData.USERS_FILE);
    List<String[]> usersRoles = csvDataLoader.
      loadManyToManyRelationship(SetupData.USERS_ROLES_FILE);

    for (String[] userRole : usersRoles) {
        User user = findByUserByUsername(users, userRole[0]);
        Set<Role> roles = user.getRoles();
        if (roles == null) {
            roles = new HashSet<Role>();
        }
        roles.add(findRoleByName(allRoles, userRole[1]));
        user.setRoles(roles);
    }
    return users;
}

private User findByUserByUsername(List<User> users, String username) {
    return users.stream().
      filter(item -> item.getUsername().equals(username)).findFirst().get();
}

次に、ユーザーの永続化に焦点を当てましょう。

private void setupUsers() {
    List<User> users = setupData.getUsers();
    for (User user : users) {
        setupService.setupUser(user);
    }
}

そして、これがSetupServiceです。

@Transactional
public void setupUser(User user) {
    try {
        setupUserInternal(user);
    } catch (Exception e) {
        logger.error("Error occurred while saving user " + user.toString(), e);
    }
}

private void setupUserInternal(User user) {
    if (userRepository.findByUsername(user.getUsername()) == null) {
        user.setPassword(passwordEncoder.encode(user.getPassword()));
        user.setPreference(createSimplePreference(user));
        Set<Role> roles = user.getRoles(); 
        Set<Role> persistedRoles = new HashSet<Role>(); 
        for (Role role : roles) { 
            persistedRoles.add(roleRepository.findByName(role.getName())); 
        } 
        user.setRoles(persistedRoles);
        userRepository.save(user);
    }
}

そして、これが createSimplePreference（）メソッドです。

private Preference createSimplePreference(User user) {
    Preference pref = new Preference();
    pref.setId(user.getId());
    pref.setTimezone(TimeZone.getDefault().getID());
    pref.setEmail(user.getUsername() + "@test.com");
    return preferenceRepository.save(pref);
}

ユーザーを保存する前に、そのユーザー用の単純な Preferences エンティティを作成し、それを最初に永続化する方法に注意してください。

5. CSVデータローダーをテストする

次に、CsvDataLoaderで簡単な単体テストを実行してみましょう。

ユーザー、ロール、および特権のロードリストをテストします。

@Test
public void whenLoadingUsersFromCsvFile_thenLoaded() {
    List<User> users = csvDataLoader.
      loadObjectList(User.class, CsvDataLoader.USERS_FILE);
    assertFalse(users.isEmpty());
}

@Test
public void whenLoadingRolesFromCsvFile_thenLoaded() {
    List<Role> roles = csvDataLoader.
      loadObjectList(Role.class, CsvDataLoader.ROLES_FILE);
    assertFalse(roles.isEmpty());
}

@Test
public void whenLoadingPrivilegesFromCsvFile_thenLoaded() {
    List<Privilege> privileges = csvDataLoader.
      loadObjectList(Privilege.class, CsvDataLoader.PRIVILEGES_FILE);
    assertFalse(privileges.isEmpty());
}

次に、データローダーを介して多対多の関係の読み込みをテストしてみましょう。

@Test
public void whenLoadingUsersRolesRelationFromCsvFile_thenLoaded() {
    List<String[]> usersRoles = csvDataLoader.
      loadManyToManyRelationship(CsvDataLoader.USERS_ROLES_FILE);
    assertFalse(usersRoles.isEmpty());
}

@Test
public void whenLoadingRolesPrivilegesRelationFromCsvFile_thenLoaded() {
    List<String[]> rolesPrivileges = csvDataLoader.
      loadManyToManyRelationship(CsvDataLoader.ROLES_PRIVILEGES_FILE);
    assertFalse(rolesPrivileges.isEmpty());
}

6. テストセットアップデータ

最後に、bean SetupDataで簡単な単体テストを実行してみましょう。

@Test
public void whenGettingUsersFromCsvFile_thenCorrect() {
    List<User> users = setupData.getUsers();

    assertFalse(users.isEmpty());
    for (User user : users) {
        assertFalse(user.getRoles().isEmpty());
    }
}

@Test
public void whenGettingRolesFromCsvFile_thenCorrect() {
    List<Role> roles = setupData.getRoles();

    assertFalse(roles.isEmpty());
    for (Role role : roles) {
        assertFalse(role.getPrivileges().isEmpty());
    }
}

@Test
public void whenGettingPrivilegesFromCsvFile_thenCorrect() {
    List<Privilege> privileges = setupData.getPrivileges();
    assertFalse(privileges.isEmpty());
}

7. 結論

この簡単な記事では、通常、起動時にシステムにロードする必要がある初期データの代替セットアップ方法について説明しました。もちろん、これは単なる概念実証であり、構築するのに適した基盤です。本番環境に対応したソリューションではありません。

また、この進行中のケーススタディによって追跡されるRedditWebアプリケーションでもこのソリューションを使用します。

getdocs

13036