Фаулер М. Архитектура корпоративных программных приложений
Подождите немного. Документ загружается.
244 Часть II. Типовые решения
Для простого числового поля идентификации выполнение вставки также мажет быть
вынесено в супертип слоя.
class Mapper...
public virtual long Insert (DomainObject arg) {
DataRow row = table.NewRow();
arg.Id = GetNextlDO;
row["id"] = arg.Id;
Save(arg, row);
table.Rows.Add(row);
return arg.Id; )
Суть вставки заключается в создании новой строки и присвоении ей следующего дос-
тупного значения ключа. После этого в новую строку останется скопировать содержимое
соответствующего объекта.
Пример: использование таблицы ключей (Java)
Мэттью Фоммвл и Мартин Фаулер
Если используемая СУБД поддерживает счетчик базы данных и вас не беспокоит за-
висимость от специфической реализации SQL, обязательно воспользуйтесь счетчиком.
Даже если вы не хотите быть привязанными к конкретной СУБД, все равно подумайте об
использовании счетчика: поскольку код генерации ключа будет хорошо инкапсулирован,
вы всегда сможете переделать его в легкопереносимый алгоритм, если это понадобится.
Вы даже можете разработать стратегию [20], чтобы использовать счетчики, когда они
есть, и создавать свои счетчики, когда их нет.
Предположим, что все приходится делать вручную. Вначале необходимо создать таб-
лицу ключей базы данных.
CREATE TABLE keys (name varchar primary key, nextID int)
INSERT INTO keys VALUES ('orders', 1)
Эта таблица будет содержать по одной строке на каждый счетчик базы данных. В на-
шем примере поле next ID инициализировано значением 1. Если вы применяете эту таб-
лицу к уже существующей базе данных, вместо единицы необходимо указать следующее
доступное значение ключа. Если ключи уникальны в пределах базы данных, вам понадо-
бится только одна строка, если они уникальны в пределах таблиц — по одной строке на
каждую таблицу.
Весь код, касающийся генерации значений ключа, можно поместить в отдельный
класс. Так его будет легче использовать в приложении и между приложениями. Кроме
того, при наличии отдельного класса процесс резервирования ключа будет легче выде-
лить в отдельную транзакцию.
В нашем примере построим генератор ключа, который будет использовать собствен-
ное соединение с базой данных и получать информацию о том, сколько ключей следует
сгенерировать за один раз.
Глава 12. Объектно-реляционные типовые решения... 245
class KeyGenerator...
private Connection conn;
private String keyName;
private long nextld;
private long maxld;
private int incrementBy;
public KeyGenerator(Connection conn, String keyName,
int incrementBy) {
this.conn = conn;
this.keyName = keyName;
this.incrementBy = incrementBy;
nextld = maxld = 0;
try {
conn.setAutoCommit(false);
} catch(SQLException exc) {
throw new ApplicationException("Unable to turn off
autocommit", exc);
} )
Необходимо гарантировать, чтобы фиксация транзакции не выполнялась автоматиче-
ски, так как операции извлечения и обновления должны осуществляться в рамках одной
транзакции.
Когда направляется запрос на вычисление нового значения ключа, генератор проверяет,
не осталось ли в его кэше неиспользованных значений, извлеченных им в прошлый раз.
class KeyGenerator...
public synchronized Long nextKeyO {
if (nextld == maxld) {
reservelds();
}
return new Long(nextld++); }
Если кэшированных значений уже не осталось, генератор вынужден обратиться к базе
данных.
class KeyGenerator...
private void reserveldsО {
PreparedStatement stmt = null;
ResultSet rs = null; long
newNextld; try {
stmt = conn.prepareStatement("SELECT nextID FROM keys
WHERE name = ? FOR UPDATE");
stmt.setString(1, keyName);
rs = stmt.executeQuery();
rs.next();
newNextld = rs.getLong(1); }
246 Часть II. Типовые решения
catch (SQLException exc) {
throw new ApplicationException("Unable to generate
ids", exc); }
finally {
DB.cleanup(stmt, rs); }
long newMaxId = newNextld + incrementBy;
stmt = null; try {
stmt = conn.prepareStatement("UPDATE keys SET
nextID = ? WHERE name = ?");
stmt.setLong(1, newMaxId);
stmt.setString(2, keyName);
stmt.executeUpdate();
conn.commit();
nextld = newNextld;
maxld = newMaxId; }
catch (SQLException exc) {
throw new ApplicationException("Unable to generate ids",
exc); } finally {
DB.cleanup(stmt); }
}
В этом примере использован оператор SELECT ... FOR UPDATE, чтобы указать базе
данных на необходимость заблокировать запись в таблице ключей. Синтаксис данного
оператора специфичен для Oracle, поэтому в других СУБД это SQL-выражение может
выглядеть несколько иначе. Когда вы не можете установить блокировку записи с помо-
щью оператора SELECT, ваша транзакция может быть прервана, если кто-то решит обно-
вить значение ключа немного раньше вас. Впрочем, в подобных случаях достаточно про-
сто перезапускать метод reserveids до тех пор, пока вы не получите "неиспорченный"
набор ключей.
Пример: использование составного ключа (Java)
Использование простого числового ключа — прекрасное решение, однако в некото-
рых случаях без составных ключей просто не обойтись.
Класс ключа
Как только ключ становится чем-то более сложным, нежели простой порядковый но-
мер, его рекомендуется выделить в отдельный класс ключа. Последний должен хранить в
себе элементы, образующие ключ, и выполнять проверку ключей на равенство.
class Key...
private Object[] fields;
public boolean equals(Object obj) {
if (!(obj instanceof Key)) return false;
Глава 12. Объектно-реляционные типовые решения... 247
Key otherKey = (Key) ob j ;
if (this.fields.length != otherKey.fields.length)
return false;
for (int i = 0; i < fields.length; i++)
if (!this.fields[i].equals(otherKey.fields[i]))
return false;
return true; )
Самый простой способ создать экземпляр класса ключа — передать его конструктору
в качестве аргумента массив полей, образующих ключ.
class Key...
public Key(Object[] fields) {
checkKeyNotNull(fields); this.fields = fields; }
private void checkKeyNotNull(Object[] fields) {
if (fields == null) throw new IllegalArgumentException(
"Cannot have a null key");
for (int i = 0; i < fields.length; i++)
if (fieldsfi] == null)
throw new IllegalArgumentException("Cannot have a
null element of key"); }
Если вам постоянно приходится создавать ключи, состоящие из конкретных элемен-
тов, к классу ключей можно добавить еще несколько конструкторов, принимающих те
или иные аргументы. Точный набор конструкторов зависит от того, ключи какого типа
используются в вашем приложении.
class Key...
public Key(long arg) {
this.fields = new Object[l];
this.fields[0] = new Long (arg);
}
public Key(Object field) {
if (field == null) throw new IllegalArgumentException(
"Cannot have a null key");
this.fields = new Objectfl];
this.fields[0] = field; } public
Key(Object argl, Object arg2) {
this.fields = new Object[2];
this.fields[0] = argl;
this.fields[1] = arg2;
CheckKeyNotNull(fields); }
He бойтесь создавать побольше подобных конструкторов. В конце концов, они очень
удобны, а это весьма важно для всех, кто работает с ключами.
248 Часть II. Типовые решения
Аналогичным образом к классу ключа можно добавить всевозможные функции дос-
тупа, которые будут применяться для извлечения различных элементов ключа. Подобные
функции необходимы приложению для выполнения отображений.
class Key...
public Object value(int i) {
return fields[i]; }
public Object value() {
checkSingleKey();
return fields[0];
}
private void
checkSingleKey() {
if (fields.length > 1)
throw new IllegalStateException("Cannot
take value on composite key");
}
public long longValueO {
checkSingleKey(); return
longValue(0); } public long
longValue(int i) {
if (! (fields [i] instanceof Long))
throw new IllegalStateException("Cannot
take longValue on non long key");
return ((Long) fields[i]).longValue();
}
В этом примере выполняется отображение объектов на таблицы заказов (orders) и
пунктов заказов (line_items). Таблица заказов имеет простой числовой ключ, а таблица
пунктов заказов— составной ключ, представляющий собой совокупность первичного
ключа заказа и порядкового номера пункта заказа в данном заказе.
CREATE TABLE orders (ID int primary key, customer varchar)
CREATE TABLE line_items (orderlD int, seq int, amount int,
^product varchar, primary key (orderlD,seq))
Супертип слоя объектов домена должен содержать в себе поле ключа.
class DomainObjectWithKey. . .
private Key key;
protected DomainObjectWithKey(Key ID) {
this.key = ID; }
protected DomainObjectWithKey() { }
public Key getKeyO {
return key; } public void
setKey(Key key) {
this.key = key; }
Глава 12. Объектно-реляционные типовые решения... 249
Чтение
Как и в других примерах этой книги, я решил разбить поведение преобразователей на
методы поиска (которые находят нужную строку базы данных) и методы загрузки
(которые загружают данные из этой строки в объект домена). И те и другие используют в
своей работе объект ключа.
Основное различие между этим и остальными примерами данной книги (в которых
применяются простые числовые ключи) состоит в необходимости вынесения в абстракт-
ный класс элементов поведения, которые позднее будут переопределены в производных
классах, имеющих более сложные ключи. В этом примере я исхожу из предположения,
что в большей части таблиц используются простые числовые ключи. Тем не менее неко-
торые таблицы применяют ключи другого типа, поэтому поведение для простых число-
вых ключей было принято в качестве стандартного и вынесено в супертип слоя преобра-
зователя. Одной из таблиц, использующих простые числовые ключи, является таблица
заказов. Ниже приведен код стандартного метода поиска.
class OrderMapper...
public Order find(Key key) {
return (Order) abstractFind(key); }
public Order find(Long id) {
return find (new Key(id)); } protected
String findStatementString() {
return "SELECT id, customer from orders WHERE id = ?"; }
class AbstractMapper...
abstract protected String findStatementString();
protected Map loadedMap = new HashMapO;
public DomainObjectWithKey abstractFind(Key key) {
DomainObjectWithKey result = (DomainObjectWithKey)
4>loadedMap.get(key);
if (result != null) return result;
ResultSet rs = null;
PreparedStatement findStatement = null;
try {
findStatement = DB.prepare(findStatementString());
loadFindStatement(key, findStatement); rs =
findStatement.executeQuery(); rs .next();
if (rs.isAfterLast()) return null;
result = load(rs); return result; }
catch (SQLException e) {
throw new ApplicationException(e);
} finally {
DB.cleanup(findStatement, rs); } ) //
метод загрузки параметров для ключей,
250 Часть II. Типовые решения
// не являющихся простыми числовыми
protected void loadFindStatement(Key key, PreparedStatement
finder) throws SQLException {
finder.setLong(1, key.longValue());
}
В приведенном коде не было реализовано построение SQL-выражения, потому что в
зависимости от типа ключа в него нужно передавать разное количество параметров. Таб-
лица пунктов заказов имеет составной ключ, поэтому метод findStatementstring
должен быть переопределен в классе LineltemMapper.
class LineltemMapper...
public Lineltem find(long orderlD, long seq) {
Key key = new Key(new Long(orderlD), new Long(seq));
return (Lineltem) abstractFind(key);
} public Lineltem find(Key key) {
return (Lineltem) abstractFind(key); }
protected String findStatementString() {
return
"SELECT orderlD, seq, amount, product " +
FROM line_iterns " +
WHERE (orderlD = ?) AND (seq = ?)";
}
// переопределение метода загрузки
// параметров для составных ключей
protected void loadFindStatement(Key key, PreparedStatement
finder) throws SQLException {
finder.setLong(1, orderlD(key));
finder.setLong(2, sequenceNumber (key));
)
// вспомогательные методы для извлечения элементов ключа
private static long orderlD(Key key) {
return key.longValue(0); } private static
long sequenceNumber(Key key) {
return key.longValue(1); }
Помимо предоставления SQL-выражения и определения интерфейса для методов по-
иска, в производном классе следует переопределить метод загрузки параметров SQL-
запроса, чтобы в соответствующее выражение можно было передать два параметра. Кро-
ме того, я написал два вспомогательных метода, предназначенных для извлечения частей
ключа. Это сделано для того, чтобы не описывать в теле метода loadFindStatement О
явный доступ к элементам ключа с указанием их номеров в массиве полей. Использова-
ние явных номеров — признак дурного тона.
Выполнение загрузки также разбито на две части: стандартное поведение для простых
числовых ключей реализовано в супертипе слоя и переопределено в производных классах
с более сложными ключами. В нашем примере загрузка объекта заказа выглядит, как по-
казано далее.
Глава 12. Объектно-реляционные типовые решения... 251
class AbstractMapper...
protected DomainObjectWithKey load(ResultSet rs)
'bthrows SQLException {
Key key = createKey(rs) ;
if (loadedMap.containsKey(key) ) return
(DomainObjectWithKey) loadedMap.get(key);
DomainObjectWithKey result = doLoad(key, rs) ;
loadedMap.put(key, result);
return result; }
abstract protected DomainObjectWithKey doLoad(Key id,
ResultSet rs) throws SQLException;
// метод загрузки параметров для ключей,
// не являющихся простыми числовыми
protected Key createKey(ResultSet rs) throws SQLException {
return new Key(rs.getLong(1)); }
class OrderMapper...
protected DomainObjectWithKey doLoad(Key key, ResultSet rs)
throws SQLException (
String customer = rs.getString("customer"); Order result =
new Order(key, customer); MapperRegistry. lineltem () .
loadAHLineltemsFor (result) ; return result; }
Классу LineitemMapper нужно переопределить метод createKey(), чтобы созда-
вать ключ, состоящий из двух полей.
class LineitemMapper...
protected DomainObjectWithKey doLoad(Key key, ResultSet rs)
throws SQLException {
Order theOrder = MapperRegistry.order().find(
orderlD(key));
return doLoad(key, rs, theOrder); }
protected DomainObjectWithKey doLoad(Key key, ResultSet rs,
Order order) throws SQLException
{
Lineltem result;
int amount = rs.getlnt("amount");
String product = rs.getString("product") ;
result = new Lineltem(key, amount, product);
order.addLineltem(result); // ссылается на заказ
return result;
)
// переопределяет стандартное поведение
protected Key createKey(ResultSet rs) throws SQLException {
Key key = new Key(new Long(rs.getLong("orderlD")),
252 Часть II. Типовые решения
"bnew Long(rs.getLong("seq")));
return key;
}
Кроме того, у класса LineitemMapper есть специальный метод, предназначенный
для загрузки всех пунктов заданного заказа.
class LineitemMapper...
public void loadAllLineltemsFor(Order arg) {
PreparedStatement stmt = null; ResultSet
rs = null; try {
stmt = DB.prepare(findForOrderString) ;
stmt.setLong(1, arg.getKey().longValue() ) ; rs =
stmt.executeQuery(); while (rs.next()) load(rs,
arg); } catch (SQLException e) {
throw new ApplicationException (e); }
finally { DB.cleanup(stmt, rs) ; } }
private final static String findForOrderString =
"SELECT orderlD, seq, amount, product " +
"FROM line_items " + "WHERE orderID = ?";
protected DomainObjectWithKey load(ResultSet rs, Order order)
•^throws SQLException {
Key key = createKey(rs); if
(loadedMap.containsKey(key)) return
(DomainObjectWithKey) loadedMap.get(key);
DomainObjectWithKey result = doLoad(key, rs, order);
loadedMap.put(key, result); return result; }
Выполнение данного метода связано с определенными трудностями, потому что объ-
ект заказа помещается в коллекцию объектов только после своего создания. Эту проблему
можно решить путем создания пустого объекта и вставки его прямо в поле идентификации
(см. стр. 237).
Вставка
Как и операция чтения, операция вставки разбита на несколько частей: в абстрактном
классе описано стандартное поведение для простых числовых ключей, переопределенное
в производных классах с более сложными ключами. В супертипе слоя преобразователя я
определил метод, который будет выступать в качестве интерфейса, а также шаблонный
метод, выполняющий вставку нового объекта.
class AbstractMapper...
public Key insert(DomainObjectWithKey subject) {
Глава 12. Объектно-реляционные типовые решения... 253
try {
return performlnsert(subject,
findNextDatabaseKeyObj ect()); } catch
(SQLException e) {
throw new ApplicationException(e) ;
protected Key performlnsert(DomainObjectWithKey subject, Key
key) throws SQLException { subject.setKey(key);
PreparedStatement stmt = DB.prepare(
insertStatementString());
insertKey(subject, stmt);
insertData(subject, stmt);
stmt.execute() ;
loadedMap.put(subject.getKey() , subject); return
subj ect.getKey(); } abstract protected String
insertStatementString();
class OrderMapper.. .
protected String insertStatementString () {
return "INSERT INTO orders VALUES(?,?)"; }
Содержимое объекта передается методу performlnsert посредством двух методов,
отделяющих элементы ключа от основных данных. Это позволит описать стандартную
реализацию вставки ключа, применимую для всех классов, использующих простой чи-
словой ключ (например, для класса Order).
class AbstractMapper...
protected void insertKey(DomainObjectWithKey subject,
PreparedStatement stmt) throws SQLException
{
stmt.setLong(1, subject.getKey().longValue());
)
Оставшаяся часть данных, передаваемых методу performlnsert, специфична для
конкретного производного класса, поэтому в суперклассе соответствующее поведение
описано как абстрактное.
class AbstractMapper...
abstract protected void insertData(DomainObjectWithKey
subject, PreparedStatement stmt) throws SQLException;
class OrderMapper...
protected void insertData(DomainObjectWithKey
abstractSubject, PreparedStatement stmt) { try {