2 Star 8 Fork 0

sagframe / sqltoy-helloworld

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

sqltoy-helloworld 项目主要展示如何快速集成sqltoy

  • 缓存翻译参见quickstart项目

学习步骤

1. 配置pom引入sqltoy的依赖

<dependency>
	<groupId>com.sagframe</groupId>
	<artifactId>sagacity-sqltoy-spring-starter</artifactId>
	<!-- jdk1.8 用5.6.4.jre8 -->
	<version>5.6.4</version>
</dependency>

<!-- 
注意注意: 配置连接池依赖

1、druid连接池
<dependency>
	<groupId>com.alibaba</groupId>
	<artifactId>druid-spring-boot-starter</artifactId>
   <version>1.2.21</version>
</dependency>

2、springboot自带的hikari连接池需要额外增加依赖
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-jdbc</artifactId>
	<version>3.2.3</version>
</dependency>
-->

2. 配置正确pom build避免sql文件无法编译到classes下面

  • 核心配置:src/main/java 下面的**/*.xml
  • Oh My God,太复杂了!冷静,这是sqltoy分享的一个实践经验,因为sqltoy提倡sql.xml文件放在业务代码模块包下面:
  • 1、便于模块化和产品化,一个模块快速抽离独立实现共用或产品化
  • 2、开发分工一般负责一个或多个模块,避免频繁跨包路径切换影响效率
<resources>
	<resource>
		<directory>src/main/java</directory>
		<excludes>
			<exclude>**/*.java</exclude>
		</excludes>
		<includes>
			<include>**/*.xml</include>
		</includes>
	</resource>
	<resource>
		<directory>src/main/resources</directory>
		<includes>
			<include>**/*.xml</include>
			<include>**/*.properties</include>
			<include>**/*.yml</include>
			<include>**/*.sql</include>
			<include>**/*.jpg</include>
		</includes>
	</resource>
</resources>
<testResources>
	<testResource>
		<directory>src/test/java</directory>
		<excludes>
			<exclude>**/*.java</exclude>
		</excludes>
		<includes>
			<include>**/*.xml</include>
		</includes>
	</testResource>
	<testResource>
		<directory>src/test/resources</directory>
		<includes>
			<include>**/*.xml</include>
			<include>**/*.properties</include>
			<include>**/*.yml</include>
			<include>**/*.sql</include>
		</includes>
	</testResource>
</testResources>

3. 配置application.yml

  • 注意要点:sqlResourcesDir 是路径名,多个路径用逗号分隔,不要填错
  • spring.sqltoy千万不要写成sqltoy漏掉spring开头
  • sqltoy不同于jpa无需配置packagesToScan或mybatis的MapperScan,sqltoy加载pojo是首次使用时加载
#完整路径:spring.sqltoy
spring:
   sqltoy:
        # 配置sql文件路径,多个用逗号分割
        sqlResourcesDir: classpath:com/sqltoy/helloworld
        # 默认为false,debug模式将打印执行sql,并自动检测sql文件更新并重新加载
        debug: true

4. 编写springboot 主程序

  • 参见:src/main/java 下面的SqlToyApplication
package com.sqltoy;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.transaction.annotation.EnableTransactionManagement;
/**
 * 
 * @project sqltoy-helloworld
 * @description helloworld 主程序入口
 * @author zhongxuchen 
 * @version v1.0, Date:2020年7月17日
 * @modify 2020年7月17日,修改说明
 */
@SpringBootApplication
@ComponentScan(basePackages = { "com.sqltoy.helloworld"})
@EnableTransactionManagement
public class SqlToyApplication {
	/**
	 * @param args
	 */
	public static void main(String[] args) {
		SpringApplication.run(SqlToyApplication.class, args);
	}
}

5. 创建表

  • 创建数据库quickstart,并执行下面的建表语句
create table SQLTOY_FRUIT_ORDER
(
   FRUIT_NAME           varchar(100) not null  comment '水果名称',
   ORDER_MONTH          integer not null  comment '订单月份',
   SALE_COUNT           numeric(10,2) not null  comment '销售数量',
   SALE_PRICE           numeric(10,2) not null  comment '销售单价',
   TOTAL_AMT            numeric(10,2) not null  comment '总金额',
   primary key (FRUIT_NAME, ORDER_MONTH)
);

alter table SQLTOY_FRUIT_ORDER comment '查询汇总演示-水果订单表';

6. 利用quickvo生产VO(或POJO)

  • 在出问题时关注dataSource中的schema、catalog配置(可去除schema和catalog),其他问题请参见quickvo.xml中的注释
  • 将数据库驱动类放于tools/quickvo/libs下面
  • 配置tools/quickvo/db.properties 文件
#############  db config ####################
jdbc.driver_class=com.mysql.cj.jdbc.Driver
# url characterEncoding=utf-8 param is need
jdbc.url=jdbc:mysql://192.168.56.101:3306/quickstart?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8&useSSL=false
# mysql schema=dbname,oracle schema=username
jdbc.schema=quickstart
jdbc.username=quickstart
jdbc.password=quickstart
  • 配置tools/quickvo/quickvo.xml 中的任务
  • 点击quickvo.bat 即可生产VO了,linux 或 mac 则执行quickvo.sh
  • windows环境下:
java -cp ./libs/* org.sagacity.quickvo.QuickVOStart quickvo.xml
  • mac电脑:
java -cp ./libs/\* org.sagacity.quickvo.QuickVOStart ./quickvo.xml

编写一个sql查询,在src/main/java/com/sqltoy/helloworld 目录下面

<?xml version="1.0" encoding="utf-8"?>
<sqltoy xmlns="http://www.sagframe.com/schema/sqltoy"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.sagframe.com/schema/sqltoy http://www.sagframe.com/schema/sqltoy/sqltoy.xsd">

	<!-- 这里是演示,正常单表查询无需写sql -->
	<sql id="helloworld_search_fruitOrder">
		<value>
			<![CDATA[
			select * from sqltoy_fruit_order t
			where #[t.FRUIT_NAME like :fruitName]
			]]>
		</value>
	</sql>
</sqltoy>

写一个service接口和对应实现类

package com.sqltoy.helloworld.service.impl;

import org.sagacity.sqltoy.dao.LightDao;
import org.sagacity.sqltoy.model.Page;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.sqltoy.helloworld.service.FruitOrderService;
import com.sqltoy.helloworld.vo.FruitOrderVO;

/**
 * 水果订单服务逻辑实现
 * 
 * @author zhongxuchen
 * @date 2021/4/19
 */
@Service("fruitOrderService")
public class FruitOrderServiceImpl implements FruitOrderService {
	// sqltoy只要注入框架自带的LightDao 就可以通过lightDao.xxx 完成全部数据库操作,具体有哪些功能可以参见LightDao
	// 功能定义
	@Autowired
	LightDao lightDao;

	@Override
	public void createFruitOrder(FruitOrderVO fruitOrderVO) {
		lightDao.save(fruitOrderVO);
	}

	@Override
	public Page<FruitOrderVO> searchFruitOrder(Page pageModel, FruitOrderVO fruitOrderVO) {
		return lightDao.findPage(pageModel, "helloworld_search_fruitOrder", fruitOrderVO, FruitOrder.class);
	}

}

写一个单元测试在 src/test/java com.sqltoy.helloworld.service

package com.sqltoy.helloworld.service;

import java.math.BigDecimal;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.sagacity.sqltoy.model.Page;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit.jupiter.SpringExtension;

import com.alibaba.fastjson.JSON;
import com.sqltoy.SqlToyApplication;
import com.sqltoy.helloworld.vo.FruitOrderVO;

/**
 * 
 * @author zhongxuchen
 *
 */
@ExtendWith(SpringExtension.class)
@SpringBootTest(classes = SqlToyApplication.class)
public class FruitOrderServiceTest {
	@Autowired
	FruitOrderService fruitOrderService;

	@Test
	public void testCreateFruitOrder() {
		FruitOrderVO fruitOrder = new FruitOrderVO();
		fruitOrder.setFruitName("苹果");
		fruitOrder.setOrderMonth(202101);
		fruitOrder.setSaleCount(BigDecimal.valueOf(100));
		fruitOrder.setSalePrice(BigDecimal.valueOf(100));
		fruitOrder.setTotalAmt(BigDecimal.valueOf(10000));
		fruitOrderService.createFruitOrder(fruitOrder);
	}

	@Test
	public void testSearchFruitOrder() {
		FruitOrderVO fruitOrder = new FruitOrderVO();
		fruitOrder.setFruitName("果");
		Page pageModel = fruitOrderService.searchFruitOrder(new Page(10, 1), fruitOrder);
		System.err.println(JSON.toJSONString(pageModel));
	}
}
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

这是sqltoy的开源演示项目 展开 收起
Java 等 3 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/sagacity/sqltoy-helloworld.git
git@gitee.com:sagacity/sqltoy-helloworld.git
sagacity
sqltoy-helloworld
sqltoy-helloworld
master

搜索帮助