pndao

Один простой вспомогательный инструмент MyBatis, который может помочь вам генерировать и поддерживать SQL-запросы на основе соглашения об именовании DAO.

pndao — это инструмент, разработанный командой Java-разработчиков «Билет Ню». В процессе реальной работы он сократил более 80% повторяющейся работы по написанию SQL, позволяя сосредоточиться на разработке самой модели. В сочетании с плагином для генерации операторов создания таблиц pngen в большинстве случаев достаточно написать один класс модели для завершения работы слоя DAO.

Особенности

1. Поддержка наиболее популярных фреймворков MyBatis без необходимости обучения.
2. Основан на общих функциях DAO, обеспечивая удобство и одновременно ограничивая соглашение об именах.
3. Возможность синхронизации изменений в структуре таблицы с изменениями в SQL.
4. Генерация XML во время компиляции, а также поддержка других фреймворков.

Вот пример типичной функции DAO:

public class UserDaoTest extends AbstractTest{

	public static final int USER_ID = 1;

	@Autowired
	private UserDao userDao;

	@Test
	public void testInsertUser() throws Exception {
		User user = initUser();
		assertThat(userDao.insert(user)).isEqualTo(1);
	}

	@Test
	public void testFindUserById() throws Exception {
		User user = userDao.findById(USER_ID);
		assertThat(user).isNotNull();
	}

	@Test
	public void testUpdateUserName() throws Exception {
		assertThat(userDao.updateForUserName("用户13700000001",USER_ID)).isEqualTo(1);
	}
}

На основе pndao все необходимые для разработки DAO методы выглядят так:

@DaoGen
public interface UserDao {

	int updateForUserName(@Param("userName") String userName, @Param("id") int id);

	int insert(User t);

	User findById(int id);

}

Использование

1. Добавьте зависимость pndao

    <artifactId>pndao</artifactId>
        <groupId>com.piaoniu</groupId>
        <version>0.2.0</version>

2. Если вы используете MyBatis, просто добавьте аннотацию @DaoGen к Dao.

3. pndao будет использовать ваши собственные SQL (включая аннотации и XML), поэтому не беспокойтесь о том, что существующие DAO перестанут работать.

4. При написании новых методов следуйте соглашению об именах pndao, чтобы воспользоваться преимуществами генерации кода.

5. В настоящее время поддерживается только Java 8.

Рекомендуется сначала ознакомиться с примерами кода в pndao-example.

Поддерживаемые методы:

Настройка

1. Если у вашей команды другое соглашение об именовании, чем у pndao:
   • Вы можете загрузить исходный код, изменить значение default префикса DaoGen и перекомпилировать.
   • Или вы можете использовать параметры компилятора -AtablePrefix=PN_ для изменения префикса таблицы по умолчанию. Вот пример:

   <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-compiler-plugin</artifactId>
       <configuration>
           <compilerArgument>-AtablePrefix=PNTS_</compilerArgument>
       </configuration>
   </plugin>
   
2. pndao основан на аннотациях JSR269, которые используются для компиляционной генерации, и работает аналогично Lombok. Поэтому теоретически его можно настроить для генерации конфигурационного кода для любого фреймворка.

Обратная связь

Проект всё ещё находится в стадии бета-тестирования, и некоторые версии могут быть неполными. Мы приветствуем предложения, использование и отправку кода.

Адрес блога команды разработчиков Piao Niu: https://piaoniu.io/.