Вывести данные настройки через CSV в приложении Spring
1. обзор
В этой статье мы будем использоватьexternalize the setup data of an application using CSV files вместо того, чтобы жестко его кодировать.
Этот процесс настройки в основном связан с настройкой новых данных в новой системе.
2. Библиотека CSV
Начнем с представления простой библиотеки для работы с CSV -Jackson CSV extension:
com.fasterxml.jackson.dataformat
jackson-dataformat-csv
2.5.3
Конечно, существует множество доступных библиотек для работы с CSV в экосистеме Java.
Причина, по которой мы идем с Джексоном здесь, заключается в том, что ... вероятно, что Джексон уже используется в приложении, и обработка, которая нам нужна для чтения данных, довольно проста.
3. Данные настройки
Разные проекты должны будут настроить разные данные.
В этом руководстве мы собираемся настроить данные пользователя - в основномpreparing the system with a few default users.
Вот простой CSV-файл, содержащий пользователей:
id,username,password,accessToken
1,john,123,token
2,tom,456,test
Обратите внимание на то, что первая строка файла -the header row, где перечислены имена полей в каждой строке данных.
3. Загрузчик данных CSV
Начнем с создания простого загрузчика данных вread up data from the CSV files into working memory.
3.1. Загрузить список объектов
Мы реализуем функциюloadObjectList() для загрузки полностью параметризованного списка конкретныхObject из файла:
public List loadObjectList(Class type, String fileName) {
try {
CsvSchema bootstrapSchema = CsvSchema.emptySchema().withHeader();
CsvMapper mapper = new CsvMapper();
File file = new ClassPathResource(fileName).getFile();
MappingIterator 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 - нам нужно будет использовать косвенный способ загрузки отношений "многие ко многим".
Мы представим этиsimilar to simple Join Tables, поэтому, естественно, загрузим с диска в виде списка массивов:
public List 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 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();
}
}
Вот как одно из этих отношений -Roles <→ Privileges - представлено в простом файле 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-компонентSetup для выполнения всей работы по настройке прав, ролей и пользователей из файлов CSV:
@Component
public class Setup {
...
@PostConstruct
private void setupData() {
setupRolesAndPrivileges();
setupUsers();
}
...
}
4.1. Настройка ролей и привилегий
Сначала загрузимroles and privileges с диска в рабочую память, а затем сохраним их как часть процесса установки:
public List getPrivileges() {
return csvDataLoader.loadObjectList(Privilege.class, PRIVILEGES_FILE);
}
public List getRoles() {
List allPrivileges = getPrivileges();
List roles = csvDataLoader.loadObjectList(Role.class, ROLES_FILE);
List rolesPrivileges = csvDataLoader.
loadManyToManyRelationship(SetupData.ROLES_PRIVILEGES_FILE);
for (String[] rolePrivilege : rolesPrivileges) {
Role role = findRoleByName(roles, rolePrivilege[0]);
Set privileges = role.getPrivileges();
if (privileges == null) {
privileges = new HashSet();
}
privileges.add(findPrivilegeByName(allPrivileges, rolePrivilege[1]));
role.setPrivileges(privileges);
}
return roles;
}
private Role findRoleByName(List roles, String roleName) {
return roles.stream().
filter(item -> item.getName().equals(roleName)).findFirst().get();
}
private Privilege findPrivilegeByName(List allPrivileges, String privilegeName) {
return allPrivileges.stream().
filter(item -> item.getName().equals(privilegeName)).findFirst().get();
}
Затем мы продолжим работу здесь:
private void setupRolesAndPrivileges() {
List privileges = setupData.getPrivileges();
for (Privilege privilege : privileges) {
setupService.setupPrivilege(privilege);
}
List 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 privileges = role.getPrivileges();
Set persistedPrivileges = new HashSet();
for (Privilege privilege : privileges) {
persistedPrivileges.add(privilegeRepository.findByName(privilege.getName()));
}
role.setPrivileges(persistedPrivileges);
roleRepository.save(role); }
}
Обратите внимание, как после загрузки ролей и привилегий в рабочую память мы загружаем их отношения по одному.
4.2. Настройка начальных пользователей
Далее - давайте загрузимusers в память и сохраним их:
public List getUsers() {
List allRoles = getRoles();
List users = csvDataLoader.loadObjectList(User.class, SetupData.USERS_FILE);
List usersRoles = csvDataLoader.
loadManyToManyRelationship(SetupData.USERS_ROLES_FILE);
for (String[] userRole : usersRoles) {
User user = findByUserByUsername(users, userRole[0]);
Set roles = user.getRoles();
if (roles == null) {
roles = new HashSet();
}
roles.add(findRoleByName(allRoles, userRole[1]));
user.setRoles(roles);
}
return users;
}
private User findByUserByUsername(List users, String username) {
return users.stream().
filter(item -> item.getUsername().equals(username)).findFirst().get();
}
Теперь давайте сосредоточимся на сохранении пользователей:
private void setupUsers() {
List 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 roles = user.getRoles();
Set persistedRoles = new HashSet();
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);
}
Обратите внимание, как перед сохранением пользователя мы создаем для него простую сущностьPreference и сохраняем ее в первую очередь.
5. Тестовый загрузчик данных CSV
Затем давайте проведем простой модульный тест на нашемCsvDataLoader:
Мы протестируем список загрузки пользователей, ролей и привилегий:
@Test
public void whenLoadingUsersFromCsvFile_thenLoaded() {
List users = csvDataLoader.
loadObjectList(User.class, CsvDataLoader.USERS_FILE);
assertFalse(users.isEmpty());
}
@Test
public void whenLoadingRolesFromCsvFile_thenLoaded() {
List roles = csvDataLoader.
loadObjectList(Role.class, CsvDataLoader.ROLES_FILE);
assertFalse(roles.isEmpty());
}
@Test
public void whenLoadingPrivilegesFromCsvFile_thenLoaded() {
List privileges = csvDataLoader.
loadObjectList(Privilege.class, CsvDataLoader.PRIVILEGES_FILE);
assertFalse(privileges.isEmpty());
}
Затем давайте протестируем загрузку некоторых отношений "многие ко многим" с помощью загрузчика данных:
@Test
public void whenLoadingUsersRolesRelationFromCsvFile_thenLoaded() {
List usersRoles = csvDataLoader.
loadManyToManyRelationship(CsvDataLoader.USERS_ROLES_FILE);
assertFalse(usersRoles.isEmpty());
}
@Test
public void whenLoadingRolesPrivilegesRelationFromCsvFile_thenLoaded() {
List rolesPrivileges = csvDataLoader.
loadManyToManyRelationship(CsvDataLoader.ROLES_PRIVILEGES_FILE);
assertFalse(rolesPrivileges.isEmpty());
}
6. Данные настройки теста
Наконец, давайте проведем простой модульный тест нашего bean-компонентаSetupData:
@Test
public void whenGettingUsersFromCsvFile_thenCorrect() {
List users = setupData.getUsers();
assertFalse(users.isEmpty());
for (User user : users) {
assertFalse(user.getRoles().isEmpty());
}
}
@Test
public void whenGettingRolesFromCsvFile_thenCorrect() {
List roles = setupData.getRoles();
assertFalse(roles.isEmpty());
for (Role role : roles) {
assertFalse(role.getPrivileges().isEmpty());
}
}
@Test
public void whenGettingPrivilegesFromCsvFile_thenCorrect() {
List privileges = setupData.getPrivileges();
assertFalse(privileges.isEmpty());
}
7. Заключение
В этой быстрой статье мы рассмотрели альтернативный метод настройки для исходных данных, который обычно должен загружаться в систему при запуске. Это, конечно, всего лишь простое доказательство концепции и хорошая основа для использования -not a production ready solution.
Мы также собираемся использовать это решение в веб-приложении Reddit, отслеживаемомthis ongoing case study.