fix: 事务逻辑手动回滚

1、事务问题引起设备无法上线问题。 2、新建设备TK异常时，删除TB设备 3、新建产品TK异常时，删除TB设备配置

fix: 事务逻辑手动回滚
1、事务问题引起设备无法上线问题。 2、新建设备TK异常时，删除TB设备 3、新建产品TK异常时，删除TB设备配置
芯火源
1 parent 0916e846
Showing 2 changed files with 114 additions and 79 deletions
application/src/main/java/org/thingsboard/server/controller/yunteng/TkDeviceController.java
application/src/main/java/org/thingsboard/server/controller/yunteng/TkDeviceProfileController.java
--- a/application/src/main/java/org/thingsboard/server/controller/yunteng/TkDeviceController.java
View file @9da261c
+++ b/application/src/main/java/org/thingsboard/server/controller/yunteng/TkDeviceController.java
View file @9da261c
@@ -11,7 +11,6 @@ import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
-import org.springframework.transaction.annotation.Transactional;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
 import org.thingsboard.rule.engine.api.msg.DeviceCredentialsUpdateNotificationMsg;
@@ -64,7 +63,6 @@ public class TkDeviceController extends BaseController {
   private final GatewayNotificationsService gatewayNotificationsService;
   @PostMapping
-  @Transactional
   @ApiOperation("创建|编辑")
   @PreAuthorize(
       "@check.checkPermissions({'TENANT_ADMIN'},{'api:yt:device:post','api:yt:device:update'})")
@@ -78,51 +76,68 @@ public class TkDeviceController extends BaseController {
     String gatewayId = deviceDTO.getGatewayId();
     DeviceDTO gateWay = null;
     if (StringUtils.isNotEmpty(gatewayId)) {
-      gateWay =
-          tkdeviceService.checkDeviceByTenantIdAndDeviceId(currentTenantId, gatewayId);
+      gateWay = tkdeviceService.checkDeviceByTenantIdAndDeviceId(currentTenantId, gatewayId);
       if (null == gateWay) {
         throw new TkDataValidationException(
             ErrorMessage.DEVICE_NOT_EXISTENCE_IN_TENANT.getMessage());
       }
     }
-    /**
-     * 子设备编辑业务逻辑： 设备地址码必须同时设置到附加信息字段内。 1、新增或编辑网关和直连设备 2、新增网关子设备 3、编辑网关子设备时，关联关系已存在(未切换网关)
-     * 4、编辑网关子设备时，关联关系不存在(切换网关) 5、编辑网关子设备时，修改其它设备信息，例如：设备名称等。
-     */
-    Device tbDevice = buildTbDeviceFromDeviceDTO(getCurrentUser().getTenantId(), deviceDTO);
-    DeviceId selfTbId = updateTbDevice(tbDevice, deviceDTO.getDeviceToken());
-    String selfTbIdStr = selfTbId.getId().toString();
-    deviceDTO.setTbDeviceId(selfTbIdStr);
-
-    if (selfTbIdStr != null
-        && deviceDTO.getDeviceType().equals(DeviceTypeEnum.SENSOR)
-        && StringUtils.isNotEmpty(gatewayId)) {
-      boolean relationNotMatched = true;
-
-      EntityId slaveId = EntityIdFactory.getByTypeAndId("DEVICE", selfTbIdStr);
-      List<EntityRelationInfo> relations =
-          relationService.findInfoByTo(getTenantId(), slaveId, RelationTypeGroup.COMMON).get();
-
-      for (EntityRelationInfo relationInfo : relations) {
-        if (!FastIotConstants.Relation.relationType.equals(relationInfo.getType())) {
-          continue;
+    DeviceDTO newDeviceDTO = null;
+    boolean created = StringUtils.isBlank(deviceDTO.getId());
+    Device savedDevice = null;
+    String selfTbIdStr = null;
+    try {
+      /**
+       * 子设备编辑业务逻辑： 设备地址码必须同时设置到附加信息字段内。 1、新增或编辑网关和直连设备 2、新增网关子设备 3、编辑网关子设备时，关联关系已存在(未切换网关)
+       * 4、编辑网关子设备时，关联关系不存在(切换网关) 5、编辑网关子设备时，修改其它设备信息，例如：设备名称等。
+       */
+      Device tbDevice = buildTbDeviceFromDeviceDTO(getCurrentUser().getTenantId(), deviceDTO);
+      savedDevice = updateTbDevice(tbDevice, deviceDTO.getDeviceToken(), created);
+      selfTbIdStr = savedDevice.getId().getId().toString();
+      deviceDTO.setTbDeviceId(selfTbIdStr);
+
+      if (selfTbIdStr != null
+          && deviceDTO.getDeviceType().equals(DeviceTypeEnum.SENSOR)
+          && StringUtils.isNotEmpty(gatewayId)) {
+        boolean relationNotMatched = true;
+
+        EntityId slaveId = EntityIdFactory.getByTypeAndId("DEVICE", selfTbIdStr);
+        List<EntityRelationInfo> relations =
+            relationService.findInfoByTo(getTenantId(), slaveId, RelationTypeGroup.COMMON).get();
+
+        for (EntityRelationInfo relationInfo : relations) {
+          if (!FastIotConstants.Relation.relationType.equals(relationInfo.getType())) {
+            continue;
+          }
+          if (relationInfo.getFrom().getId().toString().equals(gateWay.getTbDeviceId())) {
+            relationNotMatched = false;
+          } else {
+            relationService.deleteRelation(getTenantId(), relationInfo);
+            sendRelationNotificationMsg(
+                getTenantId(), relationInfo, EdgeEventActionType.RELATION_DELETED);
+          }
         }
-        if (relationInfo.getFrom().getId().toString().equals(gateWay.getTbDeviceId())) {
-          relationNotMatched = false;
-        } else {
-          relationService.deleteRelation(getTenantId(), relationInfo);
-          sendRelationNotificationMsg(
-              getTenantId(), relationInfo, EdgeEventActionType.RELATION_DELETED);
+
+        if (relationNotMatched) {
+          addRelation(getTenantId(), gateWay.getTbDeviceId(), selfTbIdStr);
         }
       }
-      if (relationNotMatched) {
-        addRelation(getTenantId(), gateWay.getTbDeviceId(), selfTbIdStr);
+      newDeviceDTO =
+          tkdeviceService.insertOrUpdate(getCurrentUser().getCurrentTenantId(), deviceDTO);
+    } catch (Exception e) {
+      if (created) {
+        logEntityAction(
+                getCurrentUser(),
+                savedDevice.getId(),
+                savedDevice,
+                savedDevice.getCustomerId(),
+                created ? ActionType.ADDED : ActionType.UPDATED,
+                e);
+        deleteTbDevice(selfTbIdStr);
+        throw handleException(e);
       }
     }
-
-    DeviceDTO newDeviceDTO =
-        tkdeviceService.insertOrUpdate(getCurrentUser().getCurrentTenantId(), deviceDTO);
     return ResponseEntity.ok(newDeviceDTO);
   }
@@ -133,10 +148,10 @@ public class TkDeviceController extends BaseController {
     return ResponseEntity.ok(result);
   }
-  private DeviceId updateTbDevice(Device tbDevice, TkCredentialsDto formCredentials)
+  private Device updateTbDevice(
+      Device tbDevice, TkCredentialsDto formCredentials, boolean created)
       throws ThingsboardException {
     Device oldDevice = null;
-    boolean created = tbDevice.getId() == null;
     if (!created) {
       oldDevice = checkDeviceId(tbDevice.getId(), Operation.WRITE);
     } else {
@@ -147,6 +162,7 @@ public class TkDeviceController extends BaseController {
     tbClusterService.onDeviceUpdated(savedDevice, oldDevice);
     DeviceId tbDeviceId = savedDevice.getId();
     DeviceCredentials deviceCredentials = null;
+    try {
       logEntityAction(
           getCurrentUser(),
           savedDevice.getId(),
@@ -184,7 +200,18 @@ public class TkDeviceController extends BaseController {
             null,
             deviceCredentials);
       }
-    return tbDeviceId;
+    } catch (Exception e) {
+      logEntityAction(
+          emptyId(EntityType.DEVICE),
+          null,
+          null,
+          ActionType.CREDENTIALS_UPDATED,
+          e,
+          deviceCredentials);
+      deleteTbDevice(tbDeviceId.getId().toString());
+      throw handleException(e);
+    }
+    return savedDevice;
   }
   @GetMapping("{id}")
@@ -482,6 +509,7 @@ public class TkDeviceController extends BaseController {
     result.setMessage(str);
     return result;
   }
+
   @GetMapping({"/attributes/{deviceProfileId}"})
   @ApiOperation("获取设备的属性")
   public ResponseEntity<JsonNode> getDeviceAttributes(
--- a/application/src/main/java/org/thingsboard/server/controller/yunteng/TkDeviceProfileController.java
View file @9da261c
+++ b/application/src/main/java/org/thingsboard/server/controller/yunteng/TkDeviceProfileController.java
View file @9da261c
@@ -7,13 +7,9 @@ import lombok.RequiredArgsConstructor;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
-import org.springframework.transaction.annotation.Transactional;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
-import org.thingsboard.server.common.data.DeviceProfile;
-import org.thingsboard.server.common.data.DeviceProfileProvisionType;
-import org.thingsboard.server.common.data.DeviceProfileType;
-import org.thingsboard.server.common.data.DeviceTransportType;
+import org.thingsboard.server.common.data.*;
 import org.thingsboard.server.common.data.audit.ActionType;
 import org.thingsboard.server.common.data.device.profile.*;
 import org.thingsboard.server.common.data.edge.EdgeEventActionType;
@@ -51,12 +47,11 @@ public class TkDeviceProfileController extends BaseController {
   private final TkDeviceProfileService tkDeviceProfileService;
   @PostMapping()
-  @Transactional
   @PreAuthorize(
-      "@check.checkPermissions({'TENANT_ADMIN'},{'api:yt:deviceProfile:post','api:yt:deviceProfile:update'})")
+          "@check.checkPermissions({'TENANT_ADMIN'},{'api:yt:deviceProfile:post','api:yt:deviceProfile:update'})")
   @ApiOperation("创建 | 编辑")
   public ResponseEntity<DeviceProfileDTO> saveDeviceProfile(
-      @RequestBody DeviceProfileDTO deviceProfileDTO) throws ThingsboardException {
+          @RequestBody DeviceProfileDTO deviceProfileDTO) throws ThingsboardException {
     boolean created = deviceProfileDTO.getId() == null;
@@ -64,10 +59,22 @@ public class TkDeviceProfileController extends BaseController {
     String tenantId = getCurrentUser().getCurrentTenantId();
     deviceProfileDTO.setTenantId(tenantId);
     DeviceProfile tbDeviceProfile = buildTbDeviceProfileFromDeviceProfileDTO(deviceProfileDTO);
+    DeviceProfile saveDeviceProfile = null;
+    try{
+      saveDeviceProfile = updateTbDeviceProfile(tbDeviceProfile);
+      deviceProfileDTO.setTbProfileId(saveDeviceProfile.getId().toString());
+      tkDeviceProfileService.insertOrUpdate(deviceProfileDTO);
+    }catch (Exception e){
+      if (created) {
+        logEntityAction(emptyId(EntityType.DEVICE_PROFILE), saveDeviceProfile,
+                null, created ? ActionType.ADDED : ActionType.UPDATED, e);
+        deviceProfileService.deleteDeviceProfile(getTenantId(), saveDeviceProfile.getId());
+        tbClusterService.onDeviceProfileDelete(saveDeviceProfile, null);
+        tbClusterService.broadcastEntityStateChangeEvent(saveDeviceProfile.getTenantId(), saveDeviceProfile.getId(), ComponentLifecycleEvent.DELETED);
+        throw handleException(e);
+      }
+    }
-    DeviceProfile saveDeviceProfile = updateTbDeviceProfile(tbDeviceProfile);
-    deviceProfileDTO.setTbProfileId(saveDeviceProfile.getId().toString());
-    tkDeviceProfileService.insertOrUpdate(deviceProfileDTO);
     return ResponseEntity.ok(deviceProfileDTO);
   }
@@ -75,24 +82,24 @@ public class TkDeviceProfileController extends BaseController {
   @GetMapping("{id}")
   @ApiOperation("详情")
   @PreAuthorize(
-      "@check.checkPermissions({'TENANT_ADMIN','CUSTOMER_USER'},{'api:yt:deviceProfile:get'})")
+          "@check.checkPermissions({'TENANT_ADMIN','CUSTOMER_USER'},{'api:yt:deviceProfile:get'})")
   public ResponseEntity<DeviceProfileDTO> getDevice(@PathVariable("id") String id)
-      throws ThingsboardException {
+          throws ThingsboardException {
     return ResponseEntity.ok(
-        tkDeviceProfileService.getDeviceProfile(getCurrentUser().getCurrentTenantId(), id));
+            tkDeviceProfileService.getDeviceProfile(getCurrentUser().getCurrentTenantId(), id));
   }
   @GetMapping(params = {PAGE_SIZE, PAGE})
   @ApiOperation("查询")
   @PreAuthorize("@check.checkPermissions({'TENANT_ADMIN','CUSTOMER_USER'},{})")
   public TkPageData<DeviceProfileDTO> pageDeviceProfile(
-      @RequestParam(PAGE_SIZE) int pageSize,
-      @RequestParam(PAGE) int page,
-      @RequestParam(value = "name", required = false) String name,
-      @RequestParam(value = "transportType", required = false) String transportType,
-      @RequestParam(value = ORDER_FILED, required = false) String orderBy,
-      @RequestParam(value = ORDER_TYPE, required = false) OrderTypeEnum orderType)
-      throws ThingsboardException {
+          @RequestParam(PAGE_SIZE) int pageSize,
+          @RequestParam(PAGE) int page,
+          @RequestParam(value = "name", required = false) String name,
+          @RequestParam(value = "transportType", required = false) String transportType,
+          @RequestParam(value = ORDER_FILED, required = false) String orderBy,
+          @RequestParam(value = ORDER_TYPE, required = false) OrderTypeEnum orderType)
+          throws ThingsboardException {
     Map<String, Object> queryMap = new HashMap<>();
     queryMap.put(PAGE, page);
     queryMap.put(PAGE_SIZE, pageSize);
@@ -109,17 +116,17 @@ public class TkDeviceProfileController extends BaseController {
   @ApiOperation("选项列表")
   @PreAuthorize("@check.checkPermissions({'TENANT_ADMIN','CUSTOMER_USER'},{})")
   public ResponseEntity listDeviceProfile(
-      @ApiParam(value = "设备类型") @RequestParam(value = "deviceType", required = false)
+          @ApiParam(value = "设备类型") @RequestParam(value = "deviceType", required = false)
           DeviceTypeEnum deviceType)
-      throws ThingsboardException {
+          throws ThingsboardException {
     List<DeviceProfileDTO> results;
     String tenantId = getCurrentUser().getCurrentTenantId();
     if (getCurrentUser().isTenantAdmin()) {
       results = tkDeviceProfileService.findDeviceProfile(tenantId, null,deviceType);
     } else {
       results =
-          tkDeviceProfileService.findCustomerDeviceProfiles(
-              tenantId, getCurrentUser().getCustomerId(),deviceType);
+              tkDeviceProfileService.findCustomerDeviceProfiles(
+                      tenantId, getCurrentUser().getCustomerId(),deviceType);
     }
     return ResponseEntity.ok(results);
@@ -129,7 +136,7 @@ public class TkDeviceProfileController extends BaseController {
   @ApiOperation("删除")
   @PreAuthorize("@check.checkPermissions({'TENANT_ADMIN'},{'api:yt:deviceProfile:delete'})")
   public void deleteDeviceProfiles(@Validated({DeleteGroup.class}) @RequestBody DeleteDTO deleteDTO)
-      throws ThingsboardException {
+          throws ThingsboardException {
     String tenantId = getCurrentUser().getCurrentTenantId();
     tkDeviceProfileService.checkDeviceProfiles(tenantId, deleteDTO.getIds());
@@ -142,8 +149,8 @@ public class TkDeviceProfileController extends BaseController {
   private void deleteTbDeviceProfile(String profileId) throws ThingsboardException {
     DeviceProfileDTO dto =
-        tkDeviceProfileService.findDeviceProfileById(
-            getCurrentUser().getCurrentTenantId(), profileId);
+            tkDeviceProfileService.findDeviceProfileById(
+                    getCurrentUser().getCurrentTenantId(), profileId);
     if (null != dto) {
       DeviceProfileId deviceProfileId = new DeviceProfileId(toUUID(dto.getTbProfileId()));
       DeviceProfile deviceProfile = checkDeviceProfileId(deviceProfileId, Operation.DELETE);
@@ -151,10 +158,10 @@ public class TkDeviceProfileController extends BaseController {
       tbClusterService.onDeviceProfileDelete(deviceProfile, null);
       tbClusterService.broadcastEntityStateChangeEvent(
-          deviceProfile.getTenantId(), deviceProfile.getId(), ComponentLifecycleEvent.DELETED);
+              deviceProfile.getTenantId(), deviceProfile.getId(), ComponentLifecycleEvent.DELETED);
       logEntityAction(
-          deviceProfileId, deviceProfile, null, ActionType.DELETED, null, deviceProfileId);
+              deviceProfileId, deviceProfile, null, ActionType.DELETED, null, deviceProfileId);
       sendEntityNotificationMsg(getTenantId(), deviceProfile.getId(), EdgeEventActionType.DELETED);
     }
@@ -163,9 +170,9 @@ public class TkDeviceProfileController extends BaseController {
   @GetMapping("/me/default")
   @ApiOperation("默认设备配置")
   public ResponseEntity<DeviceProfile> findCurrentTenantDeviceProfiles()
-      throws ThingsboardException {
+          throws ThingsboardException {
     DeviceProfile result =
-        deviceProfileService.findDefaultDeviceProfile(getCurrentUser().getTenantId());
+            deviceProfileService.findDefaultDeviceProfile(getCurrentUser().getTenantId());
     return ResponseEntity.ok(result);
   }
@@ -192,21 +199,21 @@ public class TkDeviceProfileController extends BaseController {
    * @return 封装好的TBDeviceProfile
    */
   private DeviceProfile buildTbDeviceProfileFromDeviceProfileDTO(DeviceProfileDTO deviceProfileDTO)
-      throws ThingsboardException {
+          throws ThingsboardException {
     DeviceProfile tbDeviceProfile = new DeviceProfile();
     if (StringUtils.isNotBlank(deviceProfileDTO.getId())) {
       DeviceProfileDTO findDeviceProfile =
-          tkDeviceProfileService.findDeviceProfileById(
-              getCurrentUser().getCurrentTenantId(), deviceProfileDTO.getId());
+              tkDeviceProfileService.findDeviceProfileById(
+                      getCurrentUser().getCurrentTenantId(), deviceProfileDTO.getId());
       if (StringUtils.isNotEmpty(findDeviceProfile.getTbProfileId())) {
         UUID profileId = UUID.fromString(findDeviceProfile.getTbProfileId());
         tbDeviceProfile.setId(new DeviceProfileId(profileId));
         tbDeviceProfile.setCreatedTime(
-            deviceProfileDTO.getCreateTime().toInstant(ZoneOffset.of("+8")).toEpochMilli());
+                deviceProfileDTO.getCreateTime().toInstant(ZoneOffset.of("+8")).toEpochMilli());
       }
     } else {
       tbDeviceProfile.setCreatedTime(
-          LocalDateTime.now().toInstant(ZoneOffset.of("+8")).toEpochMilli());
+              LocalDateTime.now().toInstant(ZoneOffset.of("+8")).toEpochMilli());
     }
     tbDeviceProfile.setName(deviceProfileDTO.getName());
     tbDeviceProfile.setImage(deviceProfileDTO.getImage());
@@ -221,9 +228,9 @@ public class TkDeviceProfileController extends BaseController {
     if (StringUtils.isNotBlank(chainStr)) {
       UUID chainId = UUID.fromString(chainStr);
       RuleChain chain =
-          ruleChainService.findRuleChainById(TenantId.SYS_TENANT_ID, new RuleChainId(chainId));
+              ruleChainService.findRuleChainById(TenantId.SYS_TENANT_ID, new RuleChainId(chainId));
       if (chain == null
-          || !deviceProfileDTO.getTenantId().equals(chain.getTenantId().getId().toString())) {
+              || !deviceProfileDTO.getTenantId().equals(chain.getTenantId().getId().toString())) {
         throw new TkDataValidationException(ErrorMessage.RULE_CHAIN_NOT_ENABLE.getMessage());
       }
       tbDeviceProfile.setDefaultRuleChainId(new RuleChainId(chainId));
@@ -242,7 +249,7 @@ public class TkDeviceProfileController extends BaseController {
     }
     tbDeviceProfile.setProfileData(
-        buildDeviceProfileData(transportType, deviceProfileDTO.getProfileData()));
+            buildDeviceProfileData(transportType, deviceProfileDTO.getProfileData()));
     return tbDeviceProfile;
   }
 }