Skip to content

Commit

Permalink
完整文档
Browse files Browse the repository at this point in the history
  • Loading branch information
李飞 committed Dec 4, 2019
1 parent c11a453 commit c3e4a9b
Show file tree
Hide file tree
Showing 15 changed files with 147 additions and 99 deletions.
21 changes: 19 additions & 2 deletions README.MD
Expand Up @@ -408,9 +408,26 @@ public class SampleMapperApplication

### select 操作

## 基于代码的约定

## 简便易用的可视化代码生成控制台
lightbatis 自带可视化的代码生成控制台,可以快速地生成 Entity, Mapper, Service 等代码。
在你的工程使用 Maven 加入以下依赖:
```xml

```
启动你的 SpringBoot 应用,和你应用同一个端口下可以直接访问,如 application.yml 中定义接口为 8082, 可以直接 http://localhost:8082/dal.html 访问 :
```yml
server:
port: 8082
```
会出现以下界面
![控制台首页](./doc/lightbatis-web-01.png)
生成 Mapper 类代码
![控制台 Mapper 生成](./doc/lightbatis-web-mapper.png)
生成 Service 类代码
![控制台 Service 生成](./doc/lightbatis-web-service.png)
批量生成
![控制台首页](./doc/lightbatis-web-batch.png)


## 相关工程结构

Expand Down
Binary file added doc/lightbatis-web-01.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/lightbatis-web-batch.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/lightbatis-web-mapper.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/lightbatis-web-service.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion lightbatis-core/lightbatis-core.iml
Expand Up @@ -47,7 +47,7 @@
<orderEntry type="library" name="Maven: com.github.xiaoymin:swagger-bootstrap-ui:1.9.3" level="project" />
<orderEntry type="library" name="Maven: javax.persistence:persistence-api:1.0.2" level="project" />
<orderEntry type="library" name="Maven: org.projectlombok:lombok:1.18.4" level="project" />
<orderEntry type="library" name="Maven: org.postgresql:postgresql:42.2.5" level="project" />
<orderEntry type="library" scope="RUNTIME" name="Maven: org.postgresql:postgresql:42.2.5" level="project" />
<orderEntry type="library" name="Maven: com.github.spullara.mustache.java:compiler:0.9.6" level="project" />
<orderEntry type="library" name="Maven: com.github.pagehelper:pagehelper-spring-boot-starter:1.2.3" level="project" />
<orderEntry type="library" name="Maven: com.github.pagehelper:pagehelper-spring-boot-autoconfigure:1.2.3" level="project" />
Expand Down
7 changes: 2 additions & 5 deletions lightbatis-core/pom.xml
Expand Up @@ -68,18 +68,15 @@
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<scope>runtime</scope>
</dependency>

<dependency>
<groupId>com.github.spullara.mustache.java</groupId>
<artifactId>compiler</artifactId>
<version>0.9.6</version>
</dependency>
<!-- tk.mybatis -->
<!-- <dependency> <groupId>tk.mybatis</groupId> <artifactId>mapper</artifactId>
<version>3.4.3</version> </dependency> <dependency> <groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId> <version>1.1.1</version>
</dependency> -->

<!--pagehelper -->
<dependency>
<groupId>com.github.pagehelper</groupId>
Expand Down
2 changes: 1 addition & 1 deletion lightbatis-core/src/main/resources/logback-spring.xml
Expand Up @@ -5,7 +5,7 @@
<springProperty scope="context" name="springAppName" source="spring.application.name"/>

<!-- Example for logging into the build folder of your project -->
<property name="LOG_FILE" value="./logs/aeotrade/${springAppName}/${springAppName}"/>
<property name="LOG_FILE" value="./logs/lightbatis/${springAppName}/${springAppName}"/>
<!-- 彩色日志 -->
<!-- 彩色日志依赖的渲染类 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
Expand Down
2 changes: 1 addition & 1 deletion lightbatis-samples/lightbatis-samples.iml
Expand Up @@ -132,7 +132,7 @@
<orderEntry type="library" name="Maven: org.springframework:spring-web:5.1.3.RELEASE" level="project" />
<orderEntry type="library" name="Maven: org.springframework:spring-context:5.1.3.RELEASE" level="project" />
<orderEntry type="library" name="Maven: org.springframework:spring-expression:5.1.3.RELEASE" level="project" />
<orderEntry type="library" name="Maven: mysql:mysql-connector-java:5.1.39" level="project" />
<orderEntry type="library" scope="RUNTIME" name="Maven: mysql:mysql-connector-java:5.1.39" level="project" />
<orderEntry type="library" name="Maven: com.alibaba:fastjson:1.2.52" level="project" />
<orderEntry type="library" name="Maven: com.jolbox:bonecp-spring:0.7.1.RELEASE" level="project" />
<orderEntry type="library" name="Maven: commons-dbcp:commons-dbcp:1.4" level="project" />
Expand Down
2 changes: 1 addition & 1 deletion lightbatis-samples/src/main/resources/logback-spring.xml
Expand Up @@ -5,7 +5,7 @@
<springProperty scope="context" name="springAppName" source="spring.application.name"/>

<!-- Example for logging into the build folder of your project -->
<property name="LOG_FILE" value="./logs/aeotrade/${springAppName}/${springAppName}"/>
<property name="LOG_FILE" value="./logs/lightbatis/${springAppName}/${springAppName}"/>
<!-- 彩色日志 -->
<!-- 彩色日志依赖的渲染类 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
Expand Down
4 changes: 2 additions & 2 deletions lightbatis-web/lightbatis-web.iml
Expand Up @@ -47,7 +47,7 @@
<orderEntry type="library" name="Maven: com.github.xiaoymin:swagger-bootstrap-ui:1.9.3" level="project" />
<orderEntry type="library" name="Maven: javax.persistence:persistence-api:1.0.2" level="project" />
<orderEntry type="library" name="Maven: org.projectlombok:lombok:1.18.4" level="project" />
<orderEntry type="library" name="Maven: org.postgresql:postgresql:42.2.5" level="project" />
<orderEntry type="library" scope="RUNTIME" name="Maven: org.postgresql:postgresql:42.2.5" level="project" />
<orderEntry type="library" name="Maven: com.github.spullara.mustache.java:compiler:0.9.6" level="project" />
<orderEntry type="library" name="Maven: com.github.pagehelper:pagehelper-spring-boot-starter:1.2.3" level="project" />
<orderEntry type="library" name="Maven: com.github.pagehelper:pagehelper-spring-boot-autoconfigure:1.2.3" level="project" />
Expand Down Expand Up @@ -113,7 +113,7 @@
<orderEntry type="library" name="Maven: org.springframework:spring-context:5.1.3.RELEASE" level="project" />
<orderEntry type="library" name="Maven: org.springframework:spring-aop:5.1.3.RELEASE" level="project" />
<orderEntry type="library" name="Maven: org.springframework:spring-expression:5.1.3.RELEASE" level="project" />
<orderEntry type="library" name="Maven: mysql:mysql-connector-java:5.1.39" level="project" />
<orderEntry type="library" scope="RUNTIME" name="Maven: mysql:mysql-connector-java:5.1.39" level="project" />
<orderEntry type="library" name="Maven: com.alibaba:fastjson:1.2.52" level="project" />
<orderEntry type="library" name="Maven: org.apache.commons:commons-lang3:3.8.1" level="project" />
<orderEntry type="library" name="Maven: com.jolbox:bonecp-spring:0.7.1.RELEASE" level="project" />
Expand Down
2 changes: 1 addition & 1 deletion lightbatis-web/pom.xml
Expand Up @@ -56,7 +56,7 @@
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<!--<scope>runtime</scope> -->
<scope>runtime</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.velocity/velocity -->

Expand Down
2 changes: 1 addition & 1 deletion lightbatis-web/src/main/resources/application.yml
Expand Up @@ -35,7 +35,7 @@ springfox:
path: /apidoc

logging:
config: classpath:log4j2-spring.xml
config: classpath:logback-spring.xml

mybatis:
configuration:
Expand Down
84 changes: 0 additions & 84 deletions lightbatis-web/src/main/resources/log4j2-spring.xml

This file was deleted.

118 changes: 118 additions & 0 deletions lightbatis-web/src/main/resources/logback-spring.xml
@@ -0,0 +1,118 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
<springProperty scope="context" name="springAppName" source="spring.application.name"/>

<!-- Example for logging into the build folder of your project -->
<property name="LOG_FILE" value="./logs/lightbatis/${springAppName}/${springAppName}"/>
<!-- 彩色日志 -->
<!-- 彩色日志依赖的渲染类 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
<!-- 彩色日志格式 -->
<property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

<!-- <property name="CONSOLE_LOG_PATTERN" value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr([${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-B3-ParentSpanId:-},%X{X-Span-Export:-}]){yellow} %clr(${PID:- }){magenta} %clr(-&#45;&#45;){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>-->

<!-- Appender to log to console -->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<!-- Minimum logging level to be presented in the console logs -->
<level>INFO</level>
<level>DEBUG</level>
</filter>
<encoder>
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
<charset>utf8</charset>
</encoder>
</appender>

<!-- Appender to log to file -->
<appender name="flatfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_FILE}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.gz</fileNamePattern>
<maxHistory>7</maxHistory>
</rollingPolicy>
<encoder>
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
<charset>utf8</charset>
</encoder>
</appender>
<!-- Appender to log to file in a JSON format -->
<appender name="logstash" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_FILE}.json</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_FILE}.json.%d{yyyy-MM-dd}.gz</fileNamePattern>
<maxHistory>7</maxHistory>
</rollingPolicy>
<encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
<providers>
<timestamp>
<timeZone>UTC</timeZone>
</timestamp>
<pattern>
<pattern>
{
"severity": "%level",
"service": "${springAppName:-}",
"trace": "%X{X-B3-TraceId:-}",
"span": "%X{X-B3-SpanId:-}",
"parent": "%X{X-B3-ParentSpanId:-}",
"exportable": "%X{X-Span-Export:-}",
"pid": "${PID:-}",
"thread": "%thread",
"class": "%logger{40}",
"rest": "%message"
}
</pattern>
</pattern>
</providers>
</encoder>
</appender>

<appender name="MyBatisStatistics" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_FILE}.sql.%d{yyyy-MM-dd}.gz</fileNamePattern>
<maxHistory>10</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern>
</encoder>
</appender>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!--encoder 默认配置为PatternLayoutEncoder-->
<encoder>
<pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
<charset>utf-8</charset>
</encoder>

<!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>
</appender>

<logger name="org.springframework" level="INFO" />
<logger name="org.hibernate" level="WARN" />
<logger name="titan.lightbatis.mybatis" level="INFO"/>
<logger name="titan.lightbatis.mybatis.provider.impl" level="INFO"/>

<logger name="simple" level="DEBUG">
<appender-ref ref="console" />
</logger>
​<logger name="titan.lightbatis.mybatis" level="DEBUG">
<appender-ref ref="STDOUT" />
</logger>

<root level="debug">
<!-- <appender-ref ref="console"/>-->
<!-- <appender-ref ref="logstash"/>-->
<!-- <appender-ref ref="flatfile"/>-->
<!-- 生产环境将请stdout,testfile去掉 -->
<appender-ref ref="STDOUT" />
</root>
</configuration>

0 comments on commit c3e4a9b

Please sign in to comment.