Spring beans не вводятся в миграцию на основе перехода на лету
Я пытаюсь внедрить компонент свойств конфигурации в java-код миграции flyway, но он всегда null.
Я использую spring загрузку с Flyway.
@Component
@ConfigurationProperties(prefix = "code")
public class CodesProp {
private String codePath;
}
Затем внутри кода миграции Flyway, пытаясь автоподписать этот компонент следующим образом:
public class V1_4__Migrate_codes_metadata implements SpringJdbcMigration {
@Autowired
private CodesProp codesProp ;
public void migrate(JdbcTemplate jdbcTemplate) throws Exception {
codesProp.getCodePath();
}
Здесь codeProp всегда имеет значение null.
Есть ли способ вставить spring beans внутри пролетного пути или инициализировать его перед пролетом bean?
Спасибо.
Ответы
Ответ 1
Flyway не поддерживает инъекцию зависимостей в реализации SpringJdbcMigration. Он просто ищет классы в classpath, которые реализуют SpringJdbcMigration и создает новый экземпляр, используя конструктор по умолчанию. Это выполняется в SpringJdbcMigrationResolver. Когда выполняется миграция, SpringJdbcMigrationExecutor создает новый JdbcTemplate, а затем вызывает ваш способ реализации миграции migrate.
Если вам действительно нужны зависимости, которые нужно вводить в ваши миграции на основе Java, я думаю, вам придется реализовать свой собственный MigrationResolver, который извлекает beans определенного типа из контекста приложения и создает и возвращает ResolvedMigration для каждого.
Ответ 2
Похоже, эта функциональность добавляется в Flyway 5.0. Этот вопрос возник как первый результат, когда я искал "spring beans flyway" в Google, так что другие люди все еще могут столкнуться с проблемой.
Если вы застряли на Flyway 4.0, я придумал еще одно быстрое решение, размещенное в spring - beans -отливной репозитории на моем GitHub.
1) Сообщите Spring выполнить сканирование компонентов вашего каталога db.migration.
Вы можете добавить аннотацию @ComponentScan в дополнение к @SpringBootApplication.
@SpringBootApplication
@ComponentScan({ "com.avehlies.springbeansflyway", "db.migration" })
public class SpringBeansFlywayApplication
2) Создайте SpringJdbcMigration в вашем каталоге db.migrations.
Вы поместите свой код внутри внедренного метода migrate(JdbcTemplate), хотя на самом деле вы не будете использовать JdbcTemplate. Это позволит Flyway выполнить миграцию в порядке, позволяя вашему вспомогательному классу работать с Spring.
public class V2__Add_Person implements SpringJdbcMigration {
public void migrate(JdbcTemplate jdbcTemplate) {
Person person = new Person(4, 'Cosmo Kramer');
AddPerson.addPerson(person);
}
}
3) Сделать класс аннотированным как Component и создать в нем статические методы.
Вы можете ввести beans в конструктор. Теперь миграция V ### теперь может использовать эти статические методы для работы с Spring -wired beans.
@Component
public class AddPerson {
private static PersonRepository personRepository;
public AddPerson(PersonRepository personRepository) {
this.personRepository = personRepository;
}
public static int addPerson(Person person) {
return personRepository.save(person);
}
}
Ответ 3
Если мне нравится, вы не хотите ждать Flyway 4.1, вы можете использовать Flyway 4.0 и добавить следующее к вашему приложению Spring для загрузки:
1) Создайте в своем проекте класс ApplicationContextAwareSpringJdbcMigrationResolver:
import org.flywaydb.core.api.FlywayException;
import org.flywaydb.core.api.MigrationType;
import org.flywaydb.core.api.MigrationVersion;
import org.flywaydb.core.api.configuration.FlywayConfiguration;
import org.flywaydb.core.api.migration.MigrationChecksumProvider;
import org.flywaydb.core.api.migration.MigrationInfoProvider;
import org.flywaydb.core.api.migration.spring.SpringJdbcMigration;
import org.flywaydb.core.api.resolver.ResolvedMigration;
import org.flywaydb.core.internal.resolver.MigrationInfoHelper;
import org.flywaydb.core.internal.resolver.ResolvedMigrationComparator;
import org.flywaydb.core.internal.resolver.ResolvedMigrationImpl;
import org.flywaydb.core.internal.resolver.spring.SpringJdbcMigrationExecutor;
import org.flywaydb.core.internal.resolver.spring.SpringJdbcMigrationResolver;
import org.flywaydb.core.internal.util.ClassUtils;
import org.flywaydb.core.internal.util.Location;
import org.flywaydb.core.internal.util.Pair;
import org.flywaydb.core.internal.util.StringUtils;
import org.flywaydb.core.internal.util.scanner.Scanner;
import org.springframework.context.ApplicationContext;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
/**
* Migration resolver for {@link SpringJdbcMigration}s which are registered in the given {@link ApplicationContext}.
* This resolver provides the ability to use other beans registered in the {@link ApplicationContext} and reference
* them via Spring dependency injection facility inside the {@link SpringJdbcMigration}s.
*/
public class ApplicationContextAwareSpringJdbcMigrationResolver extends SpringJdbcMigrationResolver {
private final ApplicationContext applicationContext;
public ApplicationContextAwareSpringJdbcMigrationResolver(Scanner scanner, Location location, FlywayConfiguration configuration, ApplicationContext applicationContext) {
super(scanner, location, configuration);
this.applicationContext = applicationContext;
}
@SuppressWarnings("unchecked")
@Override
public Collection<ResolvedMigration> resolveMigrations() {
// get all beans of type SpringJdbcMigration from the application context
Map<String, SpringJdbcMigration> springJdbcMigrationBeans =
(Map<String, SpringJdbcMigration>) this.applicationContext.getBeansOfType(SpringJdbcMigration.class);
ArrayList<ResolvedMigration> resolvedMigrations = new ArrayList<ResolvedMigration>();
// resolve the migration and populate it with the migration info
for (SpringJdbcMigration springJdbcMigrationBean : springJdbcMigrationBeans.values()) {
ResolvedMigrationImpl resolvedMigration = extractMigrationInfo(springJdbcMigrationBean);
resolvedMigration.setPhysicalLocation(ClassUtils.getLocationOnDisk(springJdbcMigrationBean.getClass()));
resolvedMigration.setExecutor(new SpringJdbcMigrationExecutor(springJdbcMigrationBean));
resolvedMigrations.add(resolvedMigration);
}
Collections.sort(resolvedMigrations, new ResolvedMigrationComparator());
return resolvedMigrations;
}
ResolvedMigrationImpl extractMigrationInfo(SpringJdbcMigration springJdbcMigration) {
Integer checksum = null;
if (springJdbcMigration instanceof MigrationChecksumProvider) {
MigrationChecksumProvider version = (MigrationChecksumProvider) springJdbcMigration;
checksum = version.getChecksum();
}
String description;
MigrationVersion version1;
if (springJdbcMigration instanceof MigrationInfoProvider) {
MigrationInfoProvider resolvedMigration = (MigrationInfoProvider) springJdbcMigration;
version1 = resolvedMigration.getVersion();
description = resolvedMigration.getDescription();
if (!StringUtils.hasText(description)) {
throw new FlywayException("Missing description for migration " + version1);
}
} else {
String resolvedMigration1 = ClassUtils.getShortName(springJdbcMigration.getClass());
if (!resolvedMigration1.startsWith("V") && !resolvedMigration1.startsWith("R")) {
throw new FlywayException("Invalid Jdbc migration class name: " + springJdbcMigration.getClass()
.getName() + " => ensure it starts with V or R," + " or implement org.flywaydb.core.api.migration.MigrationInfoProvider for non-default naming");
}
String prefix = resolvedMigration1.substring(0, 1);
Pair info = MigrationInfoHelper.extractVersionAndDescription(resolvedMigration1, prefix, "__", "");
version1 = (MigrationVersion) info.getLeft();
description = (String) info.getRight();
}
ResolvedMigrationImpl resolvedMigration2 = new ResolvedMigrationImpl();
resolvedMigration2.setVersion(version1);
resolvedMigration2.setDescription(description);
resolvedMigration2.setScript(springJdbcMigration.getClass().getName());
resolvedMigration2.setChecksum(checksum);
resolvedMigration2.setType(MigrationType.SPRING_JDBC);
return resolvedMigration2;
}
}
2) Добавьте новый класс конфигурации, чтобы отправить процесс Spring загруженного экземпляра Flyway:
import org.flywaydb.core.Flyway;
import org.flywaydb.core.internal.dbsupport.DbSupport;
import org.flywaydb.core.internal.dbsupport.h2.H2DbSupport;
import org.flywaydb.core.internal.dbsupport.mysql.MySQLDbSupport;
import com.pegusapps.zebra.infrastructure.repository.flyway.ApplicationContextAwareSpringJdbcMigrationResolver;
import org.flywaydb.core.internal.resolver.sql.SqlMigrationResolver;
import org.flywaydb.core.internal.util.Location;
import org.flywaydb.core.internal.util.PlaceholderReplacer;
import org.flywaydb.core.internal.util.scanner.Scanner;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;
import java.sql.SQLException;
@Configuration
@ComponentScan("db.migration")
public class FlywayConfiguration {
@Bean
public BeanPostProcessor postProcessFlyway(ApplicationContext context) {
return new BeanPostProcessor() {
@Override
public Object postProcessBeforeInitialization(Object o, String s) throws BeansException {
return o;
}
@Override
public Object postProcessAfterInitialization(Object o, String s) throws BeansException {
if (o instanceof Flyway) {
Flyway flyway = (Flyway) o;
flyway.setSkipDefaultResolvers(true);
ApplicationContextAwareSpringJdbcMigrationResolver resolver = new ApplicationContextAwareSpringJdbcMigrationResolver(
new Scanner(Thread.currentThread().getContextClassLoader()),
new Location("classpath:db/migration"),
context.getBean(org.flywaydb.core.api.configuration.FlywayConfiguration.class),
context);
SqlMigrationResolver sqlMigrationResolver = null;
try {
sqlMigrationResolver = new SqlMigrationResolver(
getDbSupport(),
new Scanner(Thread.currentThread().getContextClassLoader()),
new Location("classpath:db/migration"),
PlaceholderReplacer.NO_PLACEHOLDERS,
"UTF-8",
"V",
"R",
"__",
".sql");
} catch (SQLException e) {
e.printStackTrace();
}
flyway.setResolvers(sqlMigrationResolver, resolver);
}
return o;
}
private DbSupport getDbSupport() throws SQLException {
DataSource dataSource = context.getBean(DataSource.class);
if( ((org.apache.tomcat.jdbc.pool.DataSource)dataSource).getDriverClassName().equals("org.h2.Driver"))
{
return new H2DbSupport(dataSource.getConnection());
}
else
{
return new MySQLDbSupport(dataSource.getConnection());
}
}
};
}
}
Обратите внимание, что у меня есть некоторые жестко закодированные зависимости от tomcat jdbc пула, h2 и mysql. Если вы используете что-то еще, вам нужно будет изменить код там (если есть кто-нибудь, кто знает, как его избежать, прокомментируйте!)
Также обратите внимание, что пакет @ComponentScan должен соответствовать тому, где будут помещаться классы миграции Java.
Также обратите внимание, что мне пришлось добавить SqlMigrationResolver назад, так как я хочу поддерживать как SQL, так и Java-атрибут миграции.
3) Создайте класс Java в пакете db.migrations, который выполняет фактическую миграцию:
@Component
public class V2__add_default_surveys implements SpringJdbcMigration {
private final SurveyRepository surveyRepository;
@Autowired
public V2__add_surveys(SurveyRepository surveyRepository) {
this.surveyRepository = surveyRepository;
}
@Override
public void migrate(JdbcTemplate jdbcTemplate) throws Exception {
surveyRepository.save(...);
}
}
Обратите внимание, что вам нужно сделать класс a @Component, и ему нужно реализовать SpringJdbcMigration. В этом классе вы можете использовать инъекцию конструктора Spring для любого Spring bean из вашего контекста, вам может потребоваться выполнить миграцию.
Примечание. Обязательно отключите ddl-проверку Hibernate, поскольку проверка выполняется до запуска Flyway:
spring.jpa.hibernate.ddl-auto=none
Ответ 4
Если вы используете deltaspike, вы можете использовать BeanProvider, чтобы получить ссылку на свой класс. Вот пример DAO, но он должен хорошо работать с вашим классом.
Измените свой код DAO:
public static UserDao getInstance() {
return BeanProvider.getContextualReference(UserDao.class, false, new DaoLiteral());
}
Затем в вашем методе миграции:
UserDao userdao = UserDao.getInstance();
И у вас есть ваша ссылка.
(ссылка на: Миграция с помощью java)
Ответ 5
Короче говоря, не используйте автоматическое связывание bean-компонентов в ваших миграциях db или даже ссылочных классов из вашего приложения! Если вы реорганизуете/удаляете/изменяете классы, на которые вы ссылались в процессе миграции, это может даже не скомпилировать или еще хуже повредить ваши миграции.
Затраты на использование простого шаблона JDBC для миграции не стоят риска.
