|
| 1 | +/* |
| 2 | + * Copyright 1999-2018 Alibaba Group Holding Ltd. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package com.alibaba.csp.sentinel.slots.block; |
| 17 | + |
| 18 | +import com.alibaba.csp.sentinel.util.function.Function; |
| 19 | +import com.alibaba.csp.sentinel.util.function.Predicate; |
| 20 | + |
| 21 | +import java.util.*; |
| 22 | +import java.util.regex.Pattern; |
| 23 | + |
| 24 | +/** |
| 25 | + * Unified rule management tool, mainly used for matching and caching of regular rules and simple rules. |
| 26 | + * @author quguai |
| 27 | + * @date 2023/10/9 20:35 |
| 28 | + */ |
| 29 | +public class RuleManager<R> { |
| 30 | + |
| 31 | + private Map<String, List<R>> originalRules = new HashMap<>(); |
| 32 | + private Map<Pattern, List<R>> regexRules = new HashMap<>(); |
| 33 | + private Map<String, List<R>> regexCacheRules = new HashMap<>(); |
| 34 | + private Map<String, List<R>> simpleRules = new HashMap<>(); |
| 35 | + private Function<List<R>, List<R>> generator = Function.identity(); |
| 36 | + |
| 37 | + private final Predicate<R> predicate; |
| 38 | + |
| 39 | + public RuleManager() { |
| 40 | + predicate = r -> r instanceof AbstractRule && ((AbstractRule) r).isRegex(); |
| 41 | + } |
| 42 | + |
| 43 | + public RuleManager(Function<List<R>, List<R>> generator, Predicate<R> predicate) { |
| 44 | + this.generator = generator; |
| 45 | + this.predicate = predicate; |
| 46 | + } |
| 47 | + |
| 48 | + /** |
| 49 | + * Update rules from datasource, split rules map by regex, |
| 50 | + * rebuild the regex rule cache to reduce the performance loss caused by publish rules. |
| 51 | + * |
| 52 | + * @param rulesMap origin rules map |
| 53 | + */ |
| 54 | + public void updateRules(Map<String, List<R>> rulesMap) { |
| 55 | + originalRules = rulesMap; |
| 56 | + Map<Pattern, List<R>> regexRules = new HashMap<>(); |
| 57 | + Map<String, List<R>> simpleRules = new HashMap<>(); |
| 58 | + for (Map.Entry<String, List<R>> entry : rulesMap.entrySet()) { |
| 59 | + String resource = entry.getKey(); |
| 60 | + List<R> rules = entry.getValue(); |
| 61 | + |
| 62 | + List<R> rulesOfSimple = new ArrayList<>(); |
| 63 | + List<R> rulesOfRegex = new ArrayList<>(); |
| 64 | + for (R rule : rules) { |
| 65 | + if (predicate.test(rule)) { |
| 66 | + rulesOfRegex.add(rule); |
| 67 | + } else { |
| 68 | + rulesOfSimple.add(rule); |
| 69 | + } |
| 70 | + } |
| 71 | + if (!rulesOfRegex.isEmpty()) { |
| 72 | + regexRules.put(Pattern.compile(resource), rulesOfRegex); |
| 73 | + } |
| 74 | + if (!rulesOfSimple.isEmpty()) { |
| 75 | + simpleRules.put(resource, rulesOfSimple); |
| 76 | + } |
| 77 | + } |
| 78 | + // rebuild regex cache rules |
| 79 | + setRules(regexRules, simpleRules); |
| 80 | + } |
| 81 | + |
| 82 | + /** |
| 83 | + * Get rules by resource name, save the rule list after regular matching to improve performance |
| 84 | + * @param resource resource name |
| 85 | + * @return matching rule list |
| 86 | + */ |
| 87 | + public List<R> getRules(String resource) { |
| 88 | + List<R> result = new ArrayList<>(simpleRules.getOrDefault(resource, Collections.emptyList())); |
| 89 | + if (regexRules.isEmpty()) { |
| 90 | + return result; |
| 91 | + } |
| 92 | + if (regexCacheRules.containsKey(resource)) { |
| 93 | + result.addAll(regexCacheRules.get(resource)); |
| 94 | + return result; |
| 95 | + } |
| 96 | + synchronized (this) { |
| 97 | + if (regexCacheRules.containsKey(resource)) { |
| 98 | + result.addAll(regexCacheRules.get(resource)); |
| 99 | + return result; |
| 100 | + } |
| 101 | + List<R> compilers = matcherFromRegexRules(resource); |
| 102 | + regexCacheRules.put(resource, compilers); |
| 103 | + result.addAll(compilers); |
| 104 | + return result; |
| 105 | + } |
| 106 | + } |
| 107 | + |
| 108 | + /** |
| 109 | + * Get rules from regex rules and simple rules |
| 110 | + * @return rule list |
| 111 | + */ |
| 112 | + public List<R> getRules() { |
| 113 | + List<R> rules = new ArrayList<>(); |
| 114 | + for (Map.Entry<Pattern, List<R>> entry : regexRules.entrySet()) { |
| 115 | + rules.addAll(entry.getValue()); |
| 116 | + } |
| 117 | + for (Map.Entry<String, List<R>> entry : simpleRules.entrySet()) { |
| 118 | + rules.addAll(entry.getValue()); |
| 119 | + } |
| 120 | + return rules; |
| 121 | + } |
| 122 | + |
| 123 | + /** |
| 124 | + * Get origin rules, includes regex and simple rules |
| 125 | + * @return original rules |
| 126 | + */ |
| 127 | + public Map<String, List<R>> getOriginalRules() { |
| 128 | + return originalRules; |
| 129 | + } |
| 130 | + |
| 131 | + /** |
| 132 | + * Determine whether has rule based on the resource name |
| 133 | + * @param resource resource name |
| 134 | + * @return whether |
| 135 | + */ |
| 136 | + |
| 137 | + public boolean hasConfig(String resource) { |
| 138 | + if (resource == null) { |
| 139 | + return false; |
| 140 | + } |
| 141 | + return !getRules(resource).isEmpty(); |
| 142 | + } |
| 143 | + |
| 144 | + /** |
| 145 | + * Is valid regex rules |
| 146 | + * @param rule rule |
| 147 | + * @return weather valid regex rule |
| 148 | + */ |
| 149 | + public static boolean checkRegexResourceField(AbstractRule rule) { |
| 150 | + if (!rule.isRegex()) { |
| 151 | + return true; |
| 152 | + } |
| 153 | + String resourceName = rule.getResource(); |
| 154 | + try { |
| 155 | + Pattern.compile(resourceName); |
| 156 | + return true; |
| 157 | + } catch (Exception e) { |
| 158 | + return false; |
| 159 | + } |
| 160 | + } |
| 161 | + |
| 162 | + private List<R> matcherFromRegexRules(String resource) { |
| 163 | + List<R> compilers = new ArrayList<>(); |
| 164 | + for (Map.Entry<Pattern, List<R>> entry : regexRules.entrySet()) { |
| 165 | + if (entry.getKey().matcher(resource).matches()) { |
| 166 | + compilers.addAll(generator.apply(entry.getValue())); |
| 167 | + } |
| 168 | + } |
| 169 | + return compilers; |
| 170 | + } |
| 171 | + |
| 172 | + private synchronized void setRules(Map<Pattern, List<R>> regexRules, Map<String, List<R>> simpleRules) { |
| 173 | + this.regexRules = regexRules; |
| 174 | + this.simpleRules = simpleRules; |
| 175 | + if (regexRules.isEmpty()) { |
| 176 | + this.regexCacheRules = Collections.emptyMap(); |
| 177 | + return; |
| 178 | + } |
| 179 | + // rebuild from regex cache rules |
| 180 | + Map<String, List<R>> rebuildCacheRule = new HashMap<>(regexCacheRules.size()); |
| 181 | + for (String resource : regexCacheRules.keySet()) { |
| 182 | + rebuildCacheRule.put(resource, matcherFromRegexRules(resource)); |
| 183 | + } |
| 184 | + this.regexCacheRules = rebuildCacheRule; |
| 185 | + } |
| 186 | +} |
0 commit comments