7장 스프링 핵심 기술의 응용 - 7.1 SQL 과 DAO 의 분리

스프링의 3대 핵심 기술인 IoC/DI, 서비스 추상화, AOP 에 대해 간단히(?) 살펴보았습니다.

7장_ 스프링 핵심 기술의 응용, 557.

이번 장에서는 스프링이 제공하는 세 가지 기술을 필요에 따라 응용해보면서 스프링의 개발철학과 추구하는 가치에 대해 알아보겠습니다.

7.1 SQL과 DAO의 분리

데이터 액세스 로직이 바뀌지 않더라도 DB 의 테이블, 필드 이름과 SQL 문장이 바뀔 수 있습니다.

현재로서는 SQL 변경이 필요한 상황이 발생하면 SQL 을 담고 있는 DAO 코드가 수정되어야 합니다.

7 장에서는 DAO 에서 SQL 을 분리하도록 하겠습니다.

public class UserDaoJdbc implements UserDao {
  
  // ...

  public void add(User user) {
    this.jdbcTemplate.update(
        // highlight-next-line
        "insert into users(id, name, password, email, level, login, recommend) values (?,?,?,?,?,?,?)",
        user.getId(), 
        user.getName(), 
        user.getPassword(), 
        user.getEmail(), 
        user.getLevel().intValue(), 
        user.getLogin(), 
        user.getRecommend());
  }

  public User get(String id) {
    return this.jdbcTemplate.queryForObject(
        // highlight-next-line
        "select * from users where id = ?",
        new Object[] {id}, 
        this.userMapper);
  } 

  public void deleteAll() {
    // highlight-next-line
    this.jdbcTemplate.update("delete from users");
  }

  public int getCount() {
    // highlight-next-line
    return this.jdbcTemplate.queryForInt("select count(*) from users");
  }

  public List<User> getAll() {
    // highlight-next-line
    return this.jdbcTemplate.query("select * from users order by id",this.userMapper);
  }

  public void update(User user) {
    this.jdbcTemplate.update(
        // highlight-next-line
        "update users set name = ?, password = ?, email = ?, level = ?, login = ?, recommend = ? where id = ? ", 
        user.getName(), 
        user.getPassword(), 
        user.getEmail(), 
        user.getLevel().intValue(), 
        user.getLogin(), 
        user.getRecommend(),
        user.getId());
  }
  
}

7.1.1 XML 설정을 이용한 분리

SQL 을 스프링의 XML 설정파일로 분리할 수 있습니다.

개별 SQL 프로퍼티 방식

먼저 add() 메소드의 SQL 을 외부로 빼는 작업을 해보겠습니다.

add() 메소드에서 사용할 SQL 을 외부에서 DI 받을 수 있게 하겠습니다.

public class UserDaoJdbc implements UserDao {

  // ...
  
  // highlight-next-line
  private String sqlAdd;
  
  // highlight-start
  public void setSqlAdd(String sqlAdd) {
    this.sqlAdd = sqlAdd;
  }
  // highlight-end
  
  public void add(User user) {
    this.jdbcTemplate.update(
        // highlight-next-line
        this.sqlAdd, 
        // ...
        );
  }

}

그리고 XML 설정파일에서 userDao 빈에 sqlAdd 프로퍼티를 추가합니다.

<?xml version="1.0" encoding="UTF-8"?>
<beans ... >
            
  <bean id="userDao" class="springbook.user.dao.UserDaoJdbc">
    <property name="dataSource" ref="dataSource" />
    // highlight-next-line
    <property name="sqlAdd" value="insert into users (id, name, password, email, level, login, recommend) values(?, ?, ?, ?, ?, ?, ?)" />
    // get, delete ...
  </bean>
  
  // ...
  
</beans>

UserDaoTest 를 통해 테스트해보면 테스트는 성공합니다.

이것으로 add() 메소드에서 사용하는 SQL 은 XML 설정만을 바꿔서 수정하는 것이 가능해졌습니다.

하지만 이 방법은 매번 새로운 SQL 이 필요할 때마다 프로퍼티를 추가하고 DAO 에는 변수와 수정자 메소드를 생성해주는 불편함이 있습니다.

SQL 맵 프로퍼티 방식

SQL 을 하나의 컬렉션에 담아두는 방법을 생각해봅니다.

Map 을 이용하면 키 값으로 SQL 문장을 가져올 수 있습니다.

이번엔 Map 타입의 sqlMap 프로퍼티를 추가합니다.

기존의 sqlAdd 변수는 삭제합니다.

public class UserDaoJdbc implements UserDao {

  // sqlAdd 변수와 수정자 삭제
  
  // highlight-next-line
  private Map<String, String> sqlMap;
  
  // highlight-start
  public void setSqlMap(Map<String, String> sqlMap) {
    this.sqlMap = sqlMap;
  }
  // highlight-end
  
  public void add(User user) {
    this.jdbcTemplate.update(
        // highlight-next-line
        this.sqlMap.get("add"), 
        // ...
        );
  }

}

설정정보 XML 에도 Map 프로퍼티를 추가합니다.

test-applicationContext.xml 에서 Map 프로퍼티는 <map> 태그와 <entry> 태그를 사용하여 정의합니다.

<?xml version="1.0" encoding="UTF-8"?>
<beans ... >
            
  <bean id="userDao" class="springbook.user.dao.UserDaoJdbc">
    <property name="dataSource" ref="dataSource" />
    // highlight-start
    <property name="sqlMap">
      <map>
        <entry key="add" value="insert into users (id, name, password, email, level, login, recommend) values(?, ?, ?, ?, ?, ?, ?)" />      
        // get, delete ...
      </map>
    </property>
    // highlight-end
  </bean>
  
  // ...
  
</beans>

이제 새로운 SQL 이 필요하면 설정에 <entry> 를 만들고 SQL 을 추가하면 됩니다.

하지만 여기서도 문제가 있는데, SQL 을 가져올 때 문자열로 된 키 값을 사용하기 때문에 오타가 있어도 발견하기 어렵다는 것 입니다.

7.1.2 SQL 제공 서비스

SQL 을 코드에서 분리했지만 몇 가지 문제점이 있습니다.

일단 데이터 액세스 로직의 일부인 SQL 문장을 애플리케이션 구성정보를 가진 설정정보와 함께 두는 건 바람직하지 못합니다.

SQL 은 따로 분리되어야 독립적으로 SQL 리뷰나 튜닝작업을 하기 편합니다.

스프링의 설정파일로부터 생성되는 오브젝트와 정보는 애플리케이션을 다시 시작하기 전에는 변경이 매우 어렵습니다.

따라서 독립적인 SQL 제공 서비스가 필요합니다.

SQL 서비스 인터페이스

클라이언트인 DAO 를 SQL 서비스의 구현에서 독립시키기 위해서는 인터페이스를 만들고, DI 로 구현 클래스의 오브젝트를 주입해주어야 합니다.

지금까지 우리가 반복적으로 해왔던 일입니다.

이제 DAO 는 적절한 키를 제공하고 그에 대한 SQL 을 돌려받도록 할 것 입니다.

SqlService 인터페이스를 만들고 메소드를 정의합니다.

public interface SqlService {

  String getSql(String key) throws SqlRetrievalFailureException;
  
}

해당 메소드를 수행중에 실패하면 SqlRetrievalFailureException 예외를 던집니다.

복구가 불가능하기 때문에 런타임 예외로 정의해둡니다.

SqlRetrievalFailureException 클래스를 정의하고 메시지와 원인이 되는 예외를 담을 수 있도록 합니다.

public class SqlRetrievalFailureException extends RuntimeException {

  public SqlRetrievalFailureException() {
    super();
  }

  public SqlRetrievalFailureException(String message) {
    super(message);
  }

  public SqlRetrievalFailureException(Throwable cause) {
    super(cause);
  }

  public SqlRetrievalFailureException(String message, Throwable cause) {
    super(message, cause);
  }
  
}

이제 UserDaoJdbc 에 SqlService 인터페이스를 정의하고, 메소드도 수정합니다.

public class UserDaoJdbc implements UserDao {

  // highlight-next-line
  private SqlService sqlService;
  
  // highlight-start
  public void setSqlService(SqlService sqlService) {
    this.sqlService = sqlService;
  }
  // highlight-end
  
  // ...
  
  public void add(User user) {
    this.jdbcTemplate.update(
        // highlight-next-line
        this.sqlService.getSql("userAdd"), 
        // ...
        );
  }

  public User get(String id) {
    return this.jdbcTemplate.queryForObject(
        // highlight-next-line
        this.sqlService.getSql("userGet"),
        new Object[] {id}, 
        this.userMapper);
  }

  public void deleteAll() {
    // highlight-next-line
    this.jdbcTemplate.update(this.sqlService.getSql("userDeleteAll"));
  }

  public int getCount() {
    // highlight-next-line
    return this.jdbcTemplate.queryForInt(this.sqlService.getSql("userGetCount"));
  }

  public List<User> getAll() {
    // highlight-next-line
    return this.jdbcTemplate.query(this.sqlService.getSql("userGetAll"), this.userMapper);
  }

  public void update(User user) {
    this.jdbcTemplate.update(
        // highlight-next-line
        this.sqlService.getSql("userUpdate"),
        // ...
        );
  }
  
}

스프링 설정을 사용하는 단순 SQL 서비스

이제 SqlService 를 구현한 SimpleSqlService 를 생성합니다.

기존 UserDaoJdbc 에서 사용한 Map 타입의 프로퍼티를 이용하여 만들어 봅니다.

public class SimpleSqlService implements SqlService {
  
  // highlight-next-line
  private Map<String, String> sqlMap;
  
  // highlight-start
  public void setSqlMap(Map<String, String> sqlMap) {
    this.sqlMap = sqlMap;
  }
  // highlight-end

  public String getSql(String key) throws SqlRetrievalFailureException {
    String sql = sqlMap.get(key);
    if (sql == null)  
      throw new SqlRetrievalFailureException(key + "를 이용해서 SQL을 찾을 수 없습니다");
    else
      return sql;
  }
}

설정정보 XML 에 SimpleSqlService 를 빈으로 등록하고 sqlMap 을 프로퍼티로 등록합니다.

그리고 SimpleSqlService 빈을 UserDaoJdbc 가 사용하도록 설정합니다.

<?xml version="1.0" encoding="UTF-8"?>
<beans ... >
  
  <bean id="userDao" class="springbook.user.dao.UserDaoJdbc">
    <property name="dataSource" ref="dataSource" />
    // highlight-next-line
    <property name="sqlService" ref="sqlService" />
  </bean>
  
  // highlight-start
  <bean id="sqlService" class="springbook.user.sqlservice.SimpleSqlService">
    <property name="sqlMap">
      <map>
        <entry key="userAdd" value="insert into users(id, name, password, email, level, login, recommend) values(?,?,?,?,?,?,?)" />      
        // get, delete ...
      </map>
    </property>
  </bean>
  // highlight-end
  
  // ...
  
</beans>

이제 UserDaoJdbc 는 SQL 을 어디에 저장해두고 가져오는지에 대해 전혀 신경 쓰지 않아도 됩니다.

SqlService 인터페이스 타입의 빈을 DI 받고, 그 빈이 제공해주는 인터페이스를 통해 SQL 을 가져다 쓰기만 하면 됩니다.

또한 SqlService 인터페이스 타입의 빈은 DAO 에 영향을 주지 않은채로 구현된 내용을 변경할 수 있습니다.