dendi-wang/thingsboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Query: add SQL string with parameters

Browse Source
This commit is contained in:
Yuriy Lytvynchuk 2022-04-08 23:01:51 +03:00
parent 5809b0d6a8
commit ee4a3b90cc
2 changed files with 201 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
dao/src/main/java/org/thingsboard/server/dao/sql/query/DefaultQueryLogComponent.java
View File

@ -17,10 +17,16 @@ package org.thingsboard.server.dao.sql.query;
import lombok.extern.slf4j.Slf4j; import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value; import org.springframework.beans.factory.annotation.Value;
import org.springframework.jdbc.core.SqlParameter;
import org.springframework.jdbc.core.SqlParameterValue;
import org.springframework.jdbc.core.namedparam.NamedParameterUtils; import org.springframework.jdbc.core.namedparam.NamedParameterUtils;
import org.springframework.jdbc.core.namedparam.ParsedSql;
import org.springframework.jdbc.core.namedparam.SqlParameterSource;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
import java.util.Arrays; import java.util.Arrays;
import java.util.List;
import java.util.UUID;
@Component @Component
@Slf4j @Slf4j
@ -35,7 +41,7 @@ public class DefaultQueryLogComponent implements QueryLogComponent {
public void logQuery(QueryContext ctx, String query, long duration) { public void logQuery(QueryContext ctx, String query, long duration) {
if (logSqlQueries && duration > logQueriesThreshold) { if (logSqlQueries && duration > logQueriesThreshold) {
String sqlToUse = NamedParameterUtils.substituteNamedParameters(query, ctx); String sqlToUse = substituteParametersInSqlString(query, ctx);
log.info("QUERY: {} took {} ms", query, duration); log.info("QUERY: {} took {} ms", query, duration);
log.info("QUERY SQL TO USE: {} took {} ms", sqlToUse, duration); log.info("QUERY SQL TO USE: {} took {} ms", sqlToUse, duration);
@ -43,4 +49,70 @@ public class DefaultQueryLogComponent implements QueryLogComponent {
Arrays.asList(ctx.getParameterNames()).forEach(param -> log.info("QUERY PARAM: {} -> {}", param, ctx.getValue(param))); Arrays.asList(ctx.getParameterNames()).forEach(param -> log.info("QUERY PARAM: {} -> {}", param, ctx.getValue(param)));
} }
} }
String substituteParametersInSqlString(String sql, SqlParameterSource paramSource) {
ParsedSql parsedSql = NamedParameterUtils.parseSqlStatement(sql);
List<SqlParameter> declaredParams = NamedParameterUtils.buildSqlParameterList(parsedSql, paramSource);
StringBuilder actualSql = new StringBuilder(parsedSql.toString());
if (declaredParams.isEmpty()) {
return sql;
}
for (SqlParameter parSQL: declaredParams) {
String paramName = parSQL.getName();
if (!paramSource.hasValue(paramName)) {
continue;
}
Object value = paramSource.getValue(paramName);
if (value instanceof SqlParameterValue) {
value = ((SqlParameterValue)value).getValue();
}
if (!(value instanceof Iterable)) {
String ValueForSQLQuery = getValueForSQLQuery(value);
String sqlTemp = sql.replace(":" + paramName, ValueForSQLQuery);
sql = sqlTemp;
continue;
}
//Iterable
int count = 0;
String valueArrayStr = "";
for (Object valueTemp: (Iterable)value) {
if (count > 0) {
valueArrayStr+=", ";
}
String ValueForSQLQuery = getValueForSQLQuery(valueTemp);
valueArrayStr += ValueForSQLQuery;
++count;
}
if (!valueArrayStr.isEmpty()){
String sqlTemp = sql.replace(":" + paramName, valueArrayStr);
sql = sqlTemp;
}
}
return sql;
}
String getValueForSQLQuery(Object valueParameter) {
if (valueParameter instanceof String) {
return "'" + valueParameter + "'";
}
if (valueParameter instanceof UUID) {
return "'" + valueParameter.toString() + "'";
}
return valueParameter.toString();
}
} }

128
dao/src/test/java/org/thingsboard/server/dao/sql/query/DefaultQueryLogComponentTest.java Normal file
View File

@ -0,0 +1,128 @@
package org.thingsboard.server.dao.sql.query;
import com.datastax.oss.driver.api.core.uuid.Uuids;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.thingsboard.server.common.data.EntityType;
import org.thingsboard.server.common.data.id.TenantId;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import static org.junit.Assert.assertEquals;
@RunWith(SpringRunner.class)
@SpringBootTest(classes = DefaultQueryLogComponent.class)
class DefaultQueryLogComponentTest {
private TenantId tenantId;
private QueryContext ctx;
@Autowired
private DefaultQueryLogComponent queryLog;
@BeforeEach
void setUp() {
tenantId = new TenantId(Uuids.timeBased());
ctx = new QueryContext(new QuerySecurityContext(tenantId, null, EntityType.ALARM));
}
@Test
void substituteParametersInSqlString_StringType() {
String Name = "Mery";
String id = "ID_1";
String sql = "Select * from Table Where name = :name AND id = :id";
String sqlToUse = "Select * from Table Where name = 'Mery' AND id = 'ID_1'";
ctx.addStringParameter("name", Name);
ctx.addStringParameter("id", id);
String sqlToUse2 = queryLog.substituteParametersInSqlString(sql, ctx);
assertEquals(sqlToUse, sqlToUse2);
}
@Test
void substituteParametersInSqlString_DoubleLongType() {
double sum = 10.55;
long price = 100000;
String sql = "Select * from Table Where sum = :sum AND price = :price";
String sqlToUse = "Select * from Table Where sum = 10.55 AND price = 100000";
ctx.addDoubleParameter("sum", sum);
ctx.addLongParameter("price", price);
String sqlToUse2 = queryLog.substituteParametersInSqlString(sql, ctx);
assertEquals(sqlToUse, sqlToUse2);
}
@Test
void substituteParametersInSqlString_BooleanType() {
boolean check = true;
String sql = "Select * from Table Where check = :check AND mark = :mark";
String sqlToUse = "Select * from Table Where check = true AND mark = false";
ctx.addBooleanParameter("check", check);
ctx.addBooleanParameter("mark", false);
String sqlToUse2 = queryLog.substituteParametersInSqlString(sql, ctx);
assertEquals(sqlToUse, sqlToUse2);
}
@Test
void substituteParametersInSqlString_UuidType() {
UUID guid = Uuids.timeBased();
String sql = "Select * from Table Where guid = :guid";
String sqlToUse = "Select * from Table Where guid = '" + guid.toString() + "'";
ctx.addUuidParameter("guid", guid);
String sqlToUse2 = queryLog.substituteParametersInSqlString(sql, ctx);
assertEquals(sqlToUse, sqlToUse2);
}
@Test
void substituteParametersInSqlString_StringListType() {
List<String> ids = new ArrayList<>();
ids.add("ID_1");
ids.add("ID_2");
ids.add("ID_3");
ids.add("ID_4");
String sql = "Select * from Table Where id IN (:ids)";
String sqlToUse = "Select * from Table Where id IN ('ID_1', 'ID_2', 'ID_3', 'ID_4')";
ctx.addStringListParameter("ids", ids);
String sqlToUse2 = queryLog.substituteParametersInSqlString(sql, ctx);
assertEquals(sqlToUse, sqlToUse2);
}
@Test
void substituteParametersInSqlString_UuidListType() {
List<UUID> guids = new ArrayList<>();
guids.add(UUID.fromString("634a8d03-6871-4e01-94d0-876bf3e67dff"));
guids.add(UUID.fromString("3adbb5b8-4dc6-4faf-80dc-681a7b518b5e"));
guids.add(UUID.fromString("63a50f0c-2058-4d1d-8f15-812eb7f84412"));
String sql = "Select * from Table Where guid IN (:guids)";
String sqlToUse = "Select * from Table Where guid IN ('634a8d03-6871-4e01-94d0-876bf3e67dff', '3adbb5b8-4dc6-4faf-80dc-681a7b518b5e', '63a50f0c-2058-4d1d-8f15-812eb7f84412')";
ctx.addUuidListParameter("guids", guids);
String sqlToUse2 = queryLog.substituteParametersInSqlString(sql, ctx);
assertEquals(sqlToUse, sqlToUse2);
}
}