6

我有一个应用程序,它使用一些 Javascript 来处理基本的 Ajax 请求,例如自动完成和实时搜索。例如,我通过以下方式实现了实时搜索;我发现了一些潜在的问题,想和你谈谈,以便有更好的代码。

应用程序/控制器/company_controller.rb

def livesearch
  @companies = Company.search(params[:query])
  render :partial => "companies", :locals => {:companies => @companies}
end

应用程序/视图/公司/_companies.html.haml

- if companies.empty?
  None
- else
  %table#company_list
    %tr
      %th Name
      %th Description
      %th Products
      %th
    = render companies

应用程序/视图/公司/_livesearch_box.html.haml

= content_for :scripts, "jlivesearch companies"
= form_tag "#", :autocomplete => :off, :remote => true do
  %span.light
    Search:  
  = text_field_tag :search
  :javascript
    $('#search').livesearch({
      searchCallback: update_listed_companies,
      queryDelay: 200,
      innerText: "Search companies"
    });

公共/javascripts/companies.js

function update_listed_companies(query) {
  if(typeof query == "undefined")
    query = "";

  $("#company_list_container").showWith(
    "/companies/livesearch?query=" + query,
    false
  );
}

公共/javascripts/application.js

(function($) {
  $.fn.showWith = function (what, popup) {
    element = this;
    $.get(what, function(data) {
      element.html(data);
      if(popup)
        element.bPopup();
    });
    return element;
  };
})(jQuery);

以下是让我怀疑我的代码的最优性的事情:

  • 我有 Javascript 代码_livesearch_box.html.haml
  • 即使我把它放在里面,public/javascripts/companies_livesearch.js我也必须对其中的#search部分进行硬编码。
  • 我有#company_list_container(这_companies.html.haml是呈现的 div)硬编码在public/javascripts/companies.js.
  • 我将路径/companies/liveseach?query=硬编码在public/javascript/companies.js.
  • 我没有使用 CoffeeScript,主要是因为它期望(至少如果您使用 Barista)在某处(例如 in app/coffeescripts/)找到纯 JavaScript 代码并将其编译为public/javascripts. 但在我的应用程序中,我的;中也有一些.js.erb文件。app/views/companies例如,我有一个投票系统,它在 app/views/companies/_vote.js.erb中使用以下内容: $("#vote_link_<%= escape_javascript(@company.id.to_s) %>").html("<%= escape_javascript(vote_link_for(@company)) %>") 将“投票这家公司”链接替换为“取消投票这家公司”链接(反之亦然) Ajax 请求并由控制器中的voteand操作呈现。unvote我知道有 coffee-haml-filter 可以在 haml 文件中编译 CoffeeScript,但这不是我真正需要的,通常被弃用并被视为脏东西(?)。

所以问题至少是:

  • 如何在我的app/views/*/*.js.*?
  • 我应该有app/views/*/*.js.*文件吗?
  • 如何以最有效和最优雅的方式删除所有这些元素 id 和那些在 javascripts 中硬编码的路径?

很抱歉这个问题很长,感谢您结束它!

4

1 回答 1

6

路线

有一些解决方案,如js-routes(我的 fork),可以让您Router.post_path(3)在 JS/CS 中编写代码。这样您就可以绕过硬编码网址。

混合 JS 和 ERB

我会建议你避免混合使用 JS 和 Ruby。在大多数情况下,您可以通过重构 JS 代码来解决这个问题,结果将更易于阅读,并且可以简单地移动到纯 JS/CS 文件中。

# based on your vote-link example and assuming that your link
# looks like:
#
# %a(href="#"){:"data-company-id" => @company.id} Vote
# => <a href="#" data-company-id="6">Vote</a>

makeAllCompaniesVotable: () ->
  $('.company a.voteLink').click ->
    companyId = $(this).data('company-id')
    $.ajax
      url: Router.vote_company_path(companyId)
      # ...

除非你做邪恶的 eval-magic,否则你甚至不需要escape_javascript. 但是您必须从部分内部删除 JavaScript。jquery.livequery使过渡更容易。

$(`.company`).livequery ->
  # do something with $(this)

每次将 a.company插入文档时都会调用。

硬编码 DOM 路径

如果您正在为特定的 dom-tree(或特定视图)编写代码,我不会认为这是一种不好的做法。编写不显眼的 JS 就像编写 CSS 一样——我们也#company_list_container用 CSS 进行硬编码,不是吗?

$("#vote_link_<%= escape_javascript(@company.id.to_s) %>") # this is ugly though

从前端调用 JS 代码

为了在静态 CoffeeScript 文件和视图之间建立接口,我倾向于编写如下内容:

:javascript
  $(function(){Companies.index()});
  $(function(){Application.globalEnhancements()});

在我的观点结束时。然后,这将调用我用 CoffeeScript 编写的函数,然后使用所有需要的脚本来增强站点。可能有更好的方法(比如为 JavaScript 使用类似 Rails 的路由器 - 请参阅 Backbone.js),但它很简单并且对我有用。

另外,如果我经常需要一些数据(例如:current_user):

:javascript
  window.current_user = #{current_user.to_json};

但是我认为没有一种有效的重构方法。我必须进行大量重构才能消除我的 ERB/JS 混乱。不过还是值得的。

于 2011-03-14T15:13:35.103 回答