하지만 저번에 EmbeddedDatabaseBuilder를 사용했던 것을 떠올리며, 결국 해당 타입으로 주입을 하게 되는 것이기에 그렇게 만들어서 넣어준다.
@Bean
public DataSource embeddedDataSource() {
return new EmbeddedDatabaseBuilder()
.setName("embeddedDatabase")
.setType(EmbeddedDatabaseType.H2)
.addScript("/schema.sql").build();
}
메서드의 이름은 우리가 등록했던 bean의 id로 해준다.
마지막으로 트랜잭션 어노테이션을 위해 해당 어노테이션까지 TestApplicationContext에 붙여준다.
@EnableTransactionManagement
이렇게해서 모든 bean을 옮겼다.
초기 테스트를 위해서 붙였던 @ImportResource를 지금은 제거가 가능하다.
그렇게 수정하고 테스트를 돌려보니 성공하는 것을 볼 수 있었다.
빈 스캐닝과 자동와이어링
이렇게 만든 빈들을 생성자나 setter를 통해 주입해야한다.
스프링은 @Autowired가 붙은 수정자 메서드가 있으면 타입을 보고 주입 할 수 있는 빈을 주입한다.
만약 타입으로 주입 가능한 빈이 2개 이상이면, 그 중에서 해당 프로퍼티와 동일한 이름의 빈으로 주입한다.
그렇기에 이렇게 동일한 타입이 2개라도 각각의 이름을 통해서 빈을 주입 가능한 것이다.
@Bean
public DataSource dataSource() {}
@Bean
public DataSource embeddedDataSource() {}
@Autowired
public UserDaoImpl(
DataSource dataSource,
SqlService sqlService) {
this.jdbcTemplate = new JdbcTemplate(dataSource);
this.sqlService = sqlService;
}
이렇게 DataSource로 받지만, 실제 사용하는건 JdbcTemplate과 같은 경우 JdbcTemplate을 주입받을 수는 없으니 반드시 setter나 생성자를 통해 주입 받아야 한다.
@Component를 통해서도 빈 등록이 가능하다.
이 @Component는 클래스에 사용하는 어노테이션이고, 이 어노테이션이 부여된 클래스는 자동으로 빈으로 등록된다.
현재 작성한 UserDaoImpl을 보면
@Component
public class UserDaoImpl implements UserDao {
//
}
이렇게 해당 클래스에 @Component를 붙이는 것 만으로도
@Bean
public UserDao userDao() {
return new UserDaoImpl(dataSource(), sqlService());
}
이거를 대체할 수 있다는 것이다.
대신에 @ComponentScan을 통해 @Component들을 검색할 범위를 지정해야 한다.
@Configuration
@EnableTransactionManagement
@ComponentScan(basePackages = "seungkyu")
public class TestApplicationContext { }
이렇게 범위를 지정해서 그 패키지들의 하위 클래스들을 검색하도록 해야한다.
@Component에서 클래스는 해당 클래스로 등록하고, 빈의 아이디는 특별하게 지정하지 않으면 클래스의 이름을 첫글자 소문자로 바꿔서 사용한다.
현재 UserDaoImpl이기에 빈의 아이디는 userDaoImpl로 지정이 되겠지만, UserDao의 구현체이기에 해당 UserDao의 타입으로도 주입이 되게 된다.
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Component
public @interface SeungkyuComponent {
}
이런 식으로 @Component 어노테이션을 가지고 있는 어노테이션은 빈으로 등록이 된다.
그런 빈 중에서도 @Service, @Repository와 같은 특별한 역할을 하는 빈들이 있기에 맞게 달아주도록 하자.
여기는 현재 데이터베이스에 접근하는 코드이니 @Repository를 붙여주도록 하겠다.
빈을 등록하다보면 다음과 같은 상황이 생길 수 있다.
타입으로 주입을 시도하려고 했지만, 같은 타입이 2개 있고 이름으로도 주입할 수 없는 상황이다.
기존에는 UserServiceImpl을 UserService로 id를 지정해서 빈을 등록했지만, 지금은 클래스의 이름으로 등록이 되었기에 저 중 어떤 id도 userService와 맞지 않아 어떤 빈을 주입할지 에러가 생긴 것이다.
이 문제를 해결해주기 위해서는 다시 UserServiceImpl을 UserService로 등록해주면 된다.
@Component("userService")
@RequiredArgsConstructor
public class UserServiceImpl implements UserService{}
이 방법으로 빈을 등록해주도록 하자.
그러면 나머지 이 testUserServiceImpl은 어떻게 사용하게 될까?
컨텍스트 분리와 @Import
이렇게 DI를 사용해왔던 이유는 언젠가 사용할 테스트 때문이다.
그리고 지금 이 testUserServiceImpl도 테스트 때에만 사용하기에 어떻게 처리를 할지 고민하는 것이다.
다른 애플리케이션 빈에서는 분리하는 것이 더 좋아보인다.
일단 테스트에서 사용할 빈들을 따로 빼두는 Configuration을 만들어보자.
@Configuration
public class TestAppContext {
@Autowired UserDao userDao;
@Bean
public UserService testUserService(){
return new TestUserServiceImpl(userDao, mailSender());
}
@Bean
public MailSender mailSender() {
return new MailSenderTest();
}
}
이제 테스트 환경에서는 이거를 주입하면 될 거 같다.
그렇다고 이거를 ComponentScan의 범위로 넣을 수는 없을 것이기에, 해당 테스트 환경에서만 주입해주도록 해야한다.
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = {TestApplicationContext.class, TestAppContext.class})
class UserDaoTest {}
마지막으로 데이터베이스 연결과 같은 부분도 분리하도록 하겠다.
결국 Configuration에도 같은 관심사끼리 모아두는 것이 유지보수에는 유리할 것이다.
@Configuration
public class SqlServiceContext {
@Bean
public SqlRegistry sqlRegistry() {
return new ConcurrentHashMapSqlRegistry();
}
@Bean
public SqlReader sqlReader() {
return new YmlSqlReader("/sqlmap.yml");
}
@Bean
public SqlService sqlService() {
return new YmlSqlService(sqlReader(), sqlRegistry());
}
@Bean
public DataSource dataSource() {
return new EmbeddedDatabaseBuilder()
.setName("embeddedDatabase")
.setType(EmbeddedDatabaseType.H2)
.addScript("/schema.sql")
.build();
}
}
이렇게 일단 지금 가지고 있는건 SqlServiceContext, TestAppContext, TestApplicationContext 이렇게 3개이다.
일단 혼동되지 않게 TestApplicationContext를 AppContext로 바꿔주자.
이거를 모두 배열로 @ContextConfiguration에 넣어줘야 할까?
하지만 여기서 의존관계를 살펴보면 SqlServiceContext를 AppContext가 필요로하고, 솔직히 테스트 클래스나 TestAppContext는 관심이 없다.
그렇기에 SqlServiceContext를 AppContext에만 직접 넣어주도록 만들어주는 것이 좋을 것 같다.
@Import(SqlServiceContext.class)
public class AppContext {}
이 방법으로 직접 넣어주고 다른 부분은 수정하지 않도록 만들자.
프로파일
현재 방법은 다음과 같은 문제가 있다.
현재 운영, 테스트가 공통으로 사용하는 AppContext와 TestAppContext 이렇게 2개가 있고 여기 모두에서 UserService 타입의 빈이 정의되어있다.
하나는 MailSenderImpl 타입이고 다른 하나는 MailSenderTest이다.
그럼 MailSender를 주입 받을 때, 어떤 타입을 주입받게 될까.
지금도 이렇게 충돌이 일어나고 있고, 우리는 테스트 환경에서는 testUserService를 데리고 오고 싶은 것이다.
이렇게 테스트 환경과 운영환경에서 각각 다른 빈을 가져와야 하는 경우가 많다.
스프링은 이렇게 환경에 따라서 빈 설정정보가 달라져야 하는 경우에 간단하게 해당 설정들을 만들 수 있도록 방법을 제공한다.
프로파일은 클래스 단위로 지정한다.
@Profile 어노테이션을 사용해서 프로파일의 이름을 넣어주면 된다.
@Configuration
@Profile("test")
public class TestAppContext {
}
이제 이렇게 하고 실행을 해보면, 당연히 실패한다.
MailSender를 가져오지 못해 실패하는데, 따로 저 profile을 활성화해주지 않아 에러가 발생하는 것이다.
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = {AppContext.class, TestAppContext.class, ProductionAppContext.class})
@ActiveProfiles("test")
class UserDaoTest {}
이렇게 ActiveProfiles로 test를 활성화 해줘야, test의 profile들을 불러오게 된다.
이렇게 설정을 하고 다시 테스트를 돌려보니, 다음과 같이 성공하는 것을 볼 수 있다.
프로퍼티 소스
현재 데이터베이스의 정보가 이렇게 코드로 들어가있다.
이런 정보가 깃에 올라가면 안되기도 하고, 배포서버와 개발서버에서 다른 데이터베이스를 연결하기에 이런 정보는 코드로 작성해서는 안된다.
프로퍼티 파일로 빼도록 하자.
database.yml라는 파일을 만들고 데이터베이스의 정보는 그곳에다가 저장하도록 하겠다.
package seungkyu;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.data.crossstore.ChangeSetPersister;
import org.springframework.jdbc.core.JdbcTemplate;
import javax.sql.DataSource;
import java.util.Map;
public class EmbeddedDbSqlRegistry implements UpdatableSqlRegistry {
private final JdbcTemplate jdbcTemplate;
public EmbeddedDbSqlRegistry(DataSource dataSource) {
this.jdbcTemplate = new JdbcTemplate(dataSource);
}
@Override
public void registerSql(String key, String sql) {
jdbcTemplate.update("INSERT INTO sqlmap (key_, sql_) values (?, ?)", key, sql);
}
@Override
public String findSql(String key) {
try
{
return jdbcTemplate.queryForObject("SELECT sql_ FROM sqlmap WHERE key_ = ?", String.class, key);
}
catch(EmptyResultDataAccessException e)
{
throw new RuntimeException();
}
}
@Override
public void updateSql(String key, String sql) {
int changed = jdbcTemplate.update("UPDATE sqlmap SET sql_ = ? WHERE key_ = ?", sql, key);
}
@Override
public void updateSql(Map<String, String> sqlmap) {
for(Map.Entry<String, String> entry : sqlmap.entrySet()) {
this.updateSql(entry.getKey(), entry.getValue());
}
}
}
이제 이 EmbeddedDbSqlRegistry를 테스트 해봐야 한다.
근데 재미있게도 ConcurrentHashMapSqlRegistry와 구현한 인터페이스가 같다.
그리고 우리는 그 인터페이스의 내용만 테스트하면 끝이다.
그렇기에 해당 테스트 코드를 공유해보자.
이런식으로 추상 클래스를 만들고
public abstract class AbstractUpdatableSqlRegistryTest {
UpdatableSqlRegistry sqlRegistry;
abstract protected UpdatableSqlRegistry injectSqlRegistry();
@BeforeEach
public void setUp() {
sqlRegistry = injectSqlRegistry();
sqlRegistry.registerSql("KEY1", "SQL1");
sqlRegistry.registerSql("KEY2", "SQL2");
sqlRegistry.registerSql("KEY3", "SQL3");
}
//.....
}
기존의 ConcurrentHashMapSqlRegistryTest도 이렇게 간단하게 변경했다.
public class ConcurrentHashMapSqlRegistryTest extends AbstractUpdatableSqlRegistryTest{
@Override
protected UpdatableSqlRegistry injectSqlRegistry() {
return new ConcurrentHashMapSqlRegistry();
}
}
이렇게만 작성하고 테스트를 해봐도
기존에 작성한 4개의 테스트를 수행하는 것을 볼 수 있다.
이거를 그대로 상속받아 EmbeddedDbSqlRegistryTest를 만들어보자.
public class EmbeddedDbSqlRegistryTest extends AbstractUpdatableSqlRegistryTest{
EmbeddedDatabase db;
@Override
protected UpdatableSqlRegistry injectSqlRegistry() {
db = new EmbeddedDatabaseBuilder()
.setType(EmbeddedDatabaseType.H2)
.addScript("/schema.sql")
.build();
return new EmbeddedDbSqlRegistry(db);
}
@AfterEach
public void tearDown() {
db.shutdown();
}
}
이렇게 작성하고 테스트를 실행해보니, 다행하게 통과하는 것을 볼 수 있었다.
이제 저 EmbeddedDbSqlRegistry에 DataSource를 주입해줘야 한다.
아무생각없이 DataSource를 찾아 넣으면 MySql로 들어가기에 내장 데이터베이스를 잘 찾아서 넣어줘야 한다.
OXM은 Object-XML Mapping으로 xml과 자바 오브젝트를 매핑해주는 기술이라고 한다.
JAXB는 자바 표준에 포함되어 있어서 사용했지만, 이 외에도 다음과 같은 XML 기술들이 있다.
Castor XML, JiBX, XmlBeans, Xstream...
이 모든 기술들의 목적은 XML에서 데이터를 가져오는 것이다.
그 중 어떤 기술을 사용할지 모르기에 추상화로 만들어두는 것도 좋은 방법이라고 생각된다.
자바 -> XML을 Marshaller라고 하고
XML -> 자바를 Unmarshaller라고 한다.
'우리는 XML에서 값을 불러와야 하기에 Unmarshaller를 사용해야 한다'가 목표였지만, xml에서 무언가 조작하기가 힘들어서 yml에서 가져와서 만드는 것으로 바꿨다...
기존에 작성했던 SqlMap으로 쿼리들을 불러와보자.
@Getter
@Setter
@ToString
@Configuration
@ConfigurationProperties(prefix = "sqlmap")
public class SqlMap {
private List<SqlType> queries;
}
@Getter
@Setter
@ToString
public class SqlType {
private String value;
private String key;
}
이렇게 해두고 우선 테스트를 돌려보자.
@ExtendWith(SpringExtension.class)
@ContextConfiguration(locations = {"/test-applicationContext.xml"})
public class OxmTest {
@Test
public void unmarshallSqlMap() throws Exception {
ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
try (InputStream inputStream = getClass().getResourceAsStream("/sqlmap.yml")) {
assert inputStream != null;
SqlMap sqlMap = mapper.readValue(inputStream, SqlMap.class);
System.out.println(sqlMap);
}
}
}
우선 이렇게 작성해두면
이렇게 제대로 출력되는 것을 볼 수 있다.
OXM 서비스 추상화 적용
yml을 읽어오는 기능을 바탕으로 SqlService를 만들어보자.
기존에 사용하던 SqlRegistry를 그대로 사용하면 될테니, Reader만 yml을 읽어오도록 추가해서 등록해주면 된다.
@RequiredArgsConstructor
public class YmlSqlService implements SqlService {
private final SqlReader sqlReader;
private final SqlRegistry sqlRegistry;
@PostConstruct
public void loadSql(){
this.sqlReader.read(this.sqlRegistry);
}
public String getSql(String key){
return this.sqlRegistry.findSql(key);
}
}
이렇게 껍데기를 만들어두고, SqlReader를 구현해보자.
@RequiredArgsConstructor
public class XmlSqlReader implements SqlReader {
private final String path;
@Override
public void read(SqlRegistry sqlRegistry) {
ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
try (InputStream inputStream = getClass().getResourceAsStream(path)) {
assert inputStream != null;
SqlMap sqlMap = mapper.readValue(inputStream, SqlMap.class);
for(SqlType sqlType: sqlMap.getQueries())
{
sqlRegistry.registerSql(sqlType.getKey(), sqlType.getValue());
}
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
