草庐IT

java - IntelliJ IDEA - SQL Inside Java 代码的语法高亮

coder 2023-08-30 原文

我正在使用 IntelliJ 13 作为一个项目的 IDE，其中与 DB 的通信是通过 Spring 的 JDBC 模板完成的。当我在 Java 中有如下代码片段时:

getJdbcTemplate().queryForObject("SELECT CONVERT(VARCHAR(255), NEWID())", String.class);

其中 getJdbcTemplate() 返回初始化的 JdbcTemplate 对象，IDE 为 SQL 语句提供了正确的语法高亮显示(您可以在下面的代码片段中看到它):

.code {font-family: Monospace}
.db-stmt {background: #EDFCED}
.db-keyword {color: #000080; font-weight: bold;}
.db-column {color: #7D0C8D; font-weight: bold;}
.db-number {color: #0000FF;}
.java-class {color: #39008E; font-weight: bold;}
<span class="code">getJdbcTemplate().queryForObject("<span class="db-stmt"><span class="db-keyword">SELECT CONVERT</span>(<span class="db-keyword">VARCHAR</span>(<span class="db-number">255</span>), NEWID())</span>", String.<span class="java-class">class</span>);</span>

但是，当我使用我创建的另一种方法时:

protected String queryForString(String sql, Object... args) {
    try {
        return getJdbcTemplate().queryForObject(sql, String.class, args);
    }
    catch (RuntimeException e) {
        return null;
    }
}

对于相同的查询:

queryForString("SELECT CONVERT(VARCHAR(255), NEWID())");

SQL语句没有语法高亮。 您知道如何为不是 JdbcTemplate 或 java.sql 接口(interface)方法参数的 Java 字符串启用 SQL 语句的语法高亮显示吗？

最佳答案

您可以通过以下任意组合来做到这一点:

  1. 设置
  2. 注释
  3. 评论。

对于其中任何一个，您必须拥有(捆绑)IntelliLang插件已启用。

通过设置

您可以添加一个设置来说明特定方法的参数是某种“语言”(例如 SQL)。

  1. 打开设置(Ctrl+Alt+S/⌘,) > 编辑器 > 语言注入(inject)
  2. 在右侧，单击添加按钮并选择 Java Parameter
  3. 在语言注入(inject)设置对话框中，选择SQL (或所需的语言)在 ID 字段中
    • 您还可以指定特定的 SQL 方言，例如 MySQL , Oracle等
  4. 在“类方法”字段中，输入您要标识为采用 SQL 的方法范围。您可以通过省略号按钮打开类浏览器/搜索窗口
    • 您可以从您的代码或库中选择类
  5. 如果您的方法需要多个参数，您可以在对话框中选择参数:

现在，当您使用该方法时，IntelliJ IDEA 将自动应用语言注入(inject):

通过注解

您可以将方法参数(或变量或字段)注释为特定语言类型。默认情况下，IntelliJ IDEA 将使用 org.intellij.lang.annotations.Language annotations.jar 中的注释包含在 IntelliJ IDEA 中。它位于 <installDirectory>/redist/annotations.jar或者在 Maven 中心，org.jetbrains:annotations

注意:还有一些非官方上传的带有不同组 ID 的注释 jar，包括(但不限于)“com.intellij”。这是因为多年前，JetBrains 并没有将它们上传到 Maven Central。所以一些社区成员这样做了，但是在不同的组 ID 下。在过去的几年里，JetBrains 一直在使用(官方)组 ID“org.jetbrains”上传它们。这是其他工件在其 POM(例如 Kotlin POM)中使用的，因此应该使用。

将注释 JAR 添加到您的类路径中。 (在大多数情况下，JAR 只需要在类路径上进行开发，而在运行时不需要。因此您可以使用“提供”的 maven <scope>。)然后将您的方法的参数注释为 SQL。请注意，当您键入语言类型时，代码完成将起作用:

public void checkDatabase(String foo, @Language("SQL")String sql, String bar)

我喜欢注释，因为即使对于非 IntelliJ IDEA 用户，它也让他们知道字符串应该是有效的 SQL、XML、CSS 或其他任何东西。您还可以注释变量或字段:

如果需要，您可以更改要在设置中使用的注释 (Ctrl+Alt+S/⌘ ,) > 编辑器 > 语言注入(inject) > 高级

通过评论

作为注释的替代方法，您可以使用注释。 (我不记得这是什么时候添加的。所以它可能不在 v13 中)。不过据我所知，通过注释进行的语言注入(inject)仅适用于变量和字段。它不适用于参数。例如:

有关详细信息，请参阅 IntelliJ IDEA user guide

关于java - IntelliJ IDEA - SQL Inside Java 代码的语法高亮，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/30753512/

IntelliJInsidecodesectionkbdjavasqlintellij-ideasyntax-highlighting

有关java - IntelliJ IDEA - SQL Inside Java 代码的语法高亮的更多相关文章

  1. ruby - 树顶语法无限循环 - 2

    我脑子里浮现出一些关于一种新编程语言的想法，所以我想我会尝试实现它。一位friend建议我尝试使用Treetop(Rubygem)来创建一个解析器。Treetop的文档很少，我以前从未做过这种事情。我的解析器表现得好像有一个无限循环，但没有堆栈跟踪；事实证明很难追踪到。有人可以指出入门级解析/AST指南的方向吗？我真的需要一些列出规则、常见用法等的东西来使用像Treetop这样的工具。我的语法分析器在GitHub上，以防有人希望帮助我改进它。class{initialize=lambda(name){receiver.name=name}greet=lambda{IO.puts("He

  2. ruby - 如何在 buildr 项目中使用 Ruby 代码？ - 2

    如何在buildr项目中使用Ruby？我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序，我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/)，但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻，因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  3. ruby-on-rails - Rails 源代码 : initialize hash in a weird way? - 2

    在rails源中:https://github.com/rails/rails/blob/master/activesupport/lib/active_support/lazy_load_hooks.rb可以看到以下内容@load_hooks=Hash.new{|h,k|h[k]=[]}在IRB中，它只是初始化一个空哈希。和做有什么区别@load_hooks=Hash.new 最佳答案 查看rubydocumentationforHashnew→new_hashclicktotogglesourcenew(obj)→new_has

  4. ruby-on-rails - 使用 Sublime Text 3 突出显示 HTML 背景语法中的 ERB？ - 2

    所以我在关注Railscast，我注意到在html.erb文件中，ruby代码有一个微弱的背景高亮效果，以区别于其他代码HTML文档。我知道Ryan使用TextMate。我正在使用SublimeText3。我怎样才能达到同样的效果？谢谢! 最佳答案 为SublimeText安装ERB包。假设您安装了SublimeText包管理器*，只需点击cmd+shift+P即可获得命令菜单，然后键入installpackage并选择PackageControl:InstallPackage获取包管理器菜单。在该菜单中，键入ERB并在看到包时选择

  5. java - 等价于 Java 中的 Ruby Hash - 2

    我真的很习惯使用Ruby编写以下代码:my_hash={}my_hash['test']=1Java中对应的数据结构是什么？ 最佳答案 HashMapmap=newHashMap();map.put("test",1);我假设？ 关于java-等价于Java中的RubyHash，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions/22737685/

  6. ruby-on-rails - 浏览 Ruby 源代码 - 2

    我的主要目标是能够完全理解我正在使用的库/gem。我尝试在Github上从头到尾阅读源代码，但这真的很难。我认为更有趣、更温和的踏脚石就是在使用时阅读每个库/gem方法的源代码。例如，我想知道RubyonRails中的redirect_to方法是如何工作的:如何查找redirect_to方法的源代码？我知道在pry中我可以执行类似show-methodmethod的操作，但我如何才能对Rails框架中的方法执行此操作？您对我如何更好地理解Gem及其API有什么建议吗？仅仅阅读源代码似乎真的很难，尤其是对于框架。谢谢! 最佳答案 Ru

  7. ruby - 覆盖相似的方法，更短的语法 - 2

    在Ruby类中，我重写了三个方法，并且在每个方法中，我基本上做同样的事情:classExampleClassdefconfirmation_required?is_allowed&&superenddefpostpone_email_change?is_allowed&&superenddefreconfirmation_required?is_allowed&&superendend有更简洁的语法吗？如何缩短代码？ 最佳答案 如何使用别名？classExampleClassdefconfirmation_required?is_a

  8. ruby - 模块嵌套代码风格偏好 - 2

    我的假设是moduleAmoduleBendend和moduleA::Bend是一样的。我能够从thisblog找到解决方案,thisSOthread和andthisSOthread.为什么以及什么时候应该更喜欢紧凑语法A::B而不是另一个，因为它显然有一个缺点？我有一种直觉，它可能与性能有关，因为在更多命名空间中查找常量需要更多计算。但是我无法通过对普通类进行基准测试来验证这一点。 最佳答案 这两种写作方法经常被混淆。首先要说的是，据我所知，没有可衡量的性能差异。(在下面的书面示例中不断查找)最明显的区别，可能也是最著名的，是你的

  9. ruby - 寻找通过阅读代码确定编程语言的ruby gem？ - 2

    几个月前，我读了一篇关于ruby​​gem的博客文章，它可以通过阅读代码本身来确定编程语言。对于我的生活，我不记得博客或gem的名称。谷歌搜索“ruby编程语言猜测”及其变体也无济于事。有人碰巧知道相关gem的名称吗？ 最佳答案 是这个吗:http://github.com/chrislo/sourceclassifier/tree/master 关于ruby-寻找通过阅读代码确定编程语言的rubygem？，我们在StackOverflow上找到一个类似的问题：

  10. ruby 语法糖 : dealing with nils - 2

    可能已经问过了，但我找不到它。这里有2个常见的情况(对我来说，在编程Rails时......)用ruby​​编写是令人沮丧的:"astring".match(/abc(.+)abc/)[1]在这种情况下，我得到一个错误，因为字符串不匹配，因此在nil上调用[]运算符。我想找到的是比以下内容更好的替代方法:temp="astring".match(/abc(.+)abc/);temp.nil??nil:temp[1]简而言之，如果不匹配，则简单地返回nil而不会出错第二种情况是这样的:var=something.very.long.and.tedious.to.writevar=some

随机推荐