Первичные ключи бывают простые (одно поле) и составные (несколько полей). В этой статье рассмотрим, как задать составной ключ с помощью аннотации @EmbeddedId.
Рассмотрим пример — клетка шахматной доски. Она как раз задается составным ключом — число (по вертикали) и буква (по горизонтали).
Ниже зададим ключ в отдельном классе, но в итоге все преобразуется в одну таблицу (первичный ключ состоит из двух полей — horizontal и vertical):
Модель
Класс клетки шахматной доски, в ней ключ и остальные поля (для простоты из остальных полей только цвет):
@Entity public class ChessBoardCell { @EmbeddedId private ChessBoardCellKey chessBoardCellKey; private String color; //setters/getters/constructors }
Класс ключа
- должен быть сериализуемым
- должен быть public и иметь public no-arg constructor (как и сущности)
- аннотирован @Embeddable
- а также в нем должен быть переопределен equals() и hashcode()
Вариант с @Embeddable
@Embeddable public class ChessBoardCellKey implements Serializable { private int vertical; private char horizontal; @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; ChessBoardCellKey that = (ChessBoardCellKey) o; return vertical == that.vertical && horizontal == that.horizontal; } @Override public int hashCode() { return Objects.hash(vertical, horizontal); } //getter/setters/constructors }
Таблица
В итоге генерируется таблица, как показано на рисунке в начале статьи, скрипт ее в PostgreSQL такой:
CREATE TABLE public.chess_board_cell ( horizontal character(1) COLLATE pg_catalog."default" NOT NULL, vertical integer NOT NULL, color character varying(255) COLLATE pg_catalog."default", CONSTRAINT chess_board_cell_pkey PRIMARY KEY (horizontal, vertical) )
Первичный ключ состоит из двух NOT NULL полей horizontal и vertical.
Добавление и выборка
Репозиторий в Spring по составному ключу делается так же, как по простому:
public interface ChessBoardCellRepository extends JpaRepository<ChessBoardCell, ChessBoardCellKey> { }
И в findById() передается не Long, а составной ключ.
Создадим сервис:
@Service public class ChessBoardCellService { @Autowired private ChessBoardCellRepository chessBoardCellRepository; void addChessBoardCell(ChessBoardCell chessBoardCell){ chessBoardCellRepository.save(chessBoardCell); } }
Добавим пару клеток и сделаем выборку:
@DataJpaTest @Import(ChessBoardCellService.class) @AutoConfigureTestDatabase(replace= AutoConfigureTestDatabase.Replace.NONE) @Commit public class ChessBoardServiceTest { @Autowired ChessBoardCellService chessBoardCellService; @Autowired ChessBoardCellRepository chessBoardCellRepository; @BeforeEach void init(){ ChessBoardCellKey A1=new ChessBoardCellKey(1, 'A'); ChessBoardCell cell1=new ChessBoardCell(A1, "white"); chessBoardCellService.addChessBoardCell(cell1); ChessBoardCellKey B2=new ChessBoardCellKey(2, 'B'); ChessBoardCell cell2=new ChessBoardCell(B2, "white"); chessBoardCellService.addChessBoardCell(cell2); } @Test void shouldGetUsers(){ List<ChessBoardCell> cells=chessBoardCellRepository.findAll(); Assertions.assertEquals(2, cells.size()); } }
Итоги
Полный код примера доступен на GitHub.